Skip to main content
このページのメソッドはすべて api.apps にあり、第 1 引数にアプリ 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() は、キーから見えるアプリごとに 1 つのサマリーを、1 回のリクエストで返します。cpu と ram はアプリの実行中にのみ含まれます。

起動、停止、再起動

サーバーはコンテナが処理を終えるまでこれらの呼び出しを保持するため、タイムアウトまで最低 120 秒待機します。プラットフォームが操作を拒否した場合、呼び出しはステータス 409、code、そして空のメッセージを持つ SquareCloudAPIError をスローします: 「すでに起動済み」と「すでに停止済み」もエラーです。それらが成功を意味する場合は、自分で処理してください:

ログ

logs(appId) は、最新のコンソール出力を 1 つの文字列として返します (何もない場合は "")。
ログをライブでストリーミングするには、リアルタイムを使います。

メトリクス

metrics(appId) は直近 24 時間分を、5 分ごとに 1 ポイント、新しい順で返します。

ドメインとロードバランサー

domains() は、すべてのアプリのデフォルトホスト名とカスタムホスト名を一覧します。loadBalancers() は、複数のアプリで共有されているドメインを、プランの上限とともに一覧します。
カスタムドメインを設定するには、ネットワークを参照してください。

アプリケーションの削除

削除は元に戻せません。ファイルが再び必要になる可能性がある場合は、先に snapshot を作成してください。

次のステップ

Commit とアップロード

zip からアプリを作成するか、既存のアプリにファイルを送信します。

アプリケーション API リファレンス

これらのメソッドが呼び出す REST endpoint。

CLI でアプリを管理

同じ操作をターミナルから行います。