Skip to main content
本页的所有方法都位于 api.apps 上,并以应用 ID 作为第一个参数。appId 也可以是通过 workspace 共享的应用的组合 ID <appId>-<workspaceId>。
要列出你的应用,请使用 api.account.me():它的 applications 数组包含该密钥可见的所有应用。

获取应用

状态

status(appId) 返回带有格式化值的实时状态:
传入 { raw: true } 可改为获取数字(cpu 为百分比,ram 为 MB,network.total 和 network.now 为 [in, out] 字节对):
uptime 是一个时间戳(应用启动的时刻),而不是持续时长。使用 Date.now() - status.uptime 计算它已运行了多久。

所有应用的状态

statusAll() 在单个请求中为该密钥可见的每个应用返回一份摘要。cpu 和 ram 仅在应用运行时存在。

启动、停止和重启

服务器会保持这些调用的连接直到容器执行完动作,因此它们至少等待 120 秒才会超时。当平台拒绝该操作时,调用会抛出 SquareCloudAPIError,状态为 409,带有 code 和空消息: “已启动”和“已停止”同样是错误。如果对你而言它们意味着成功,请自行处理:

日志

logs(appId) 以单个字符串返回最新的控制台输出(没有输出时为 "")。
如需实时日志流,请使用实时。

指标

metrics(appId) 返回最近 24 小时的数据,每 5 分钟一个数据点,最新的在前。

域名和负载均衡器

domains() 列出每个应用的默认主机名和自定义主机名。loadBalancers() 列出由多个应用共享的域名,以及你的套餐限额。
要设置自定义域名,请参见网络。

删除应用

删除是永久性的。如果你可能还需要这些文件,请先创建一个 snapshot。

后续步骤

Commit 与上传

用 zip 创建应用,或向应用发送文件。

应用 API 参考

这些方法背后的 REST 端点。

用 CLI 管理应用

在终端中完成同样的操作。