アプリケーションの停止
POST /v2/apps//stop で実行中のアプリケーションを停止します。ファイル、変数、設定は保持されます。すでに停止している場合は 409 を返します。
POST
アプリケーションの停止
apps:control スコープを持つ API キーが必要です。
実行中のアプリケーションを削除せずにシャットダウンします。コンテナは停止しますが、アプリケーションのファイル、環境変数、設定はそのまま保持されるため、アプリケーションの起動 でいつでも再度起動できます。アプリケーションがすでに停止している場合、リクエストは何もしないのではなく 409 CONTAINER_ALREADY_STOPPED を返します。
アプリケーションの削除 のようにアプリケーションのスロット自体を手放すことなく、一時的にリソースを解放したい場合、例えば営業時間外にバックグラウンドワーカーを停止しておきたい場合に使用するエンドポイントです。workspace で共有されているアプリケーションでは、呼び出し元に manager、maintain、admin のいずれかのロールが必要です。
リクエストはアプリケーションごとに 3 秒あたり 1 回の停止にレート制限されており、また全アプリケーションを通じてユーザーごとに 15 秒あたり 20 回のライフサイクルアクションに制限されていて、この上限に達すると短時間ブロックされます。
パラメーター
string
必須
アプリケーションのIDです。アプリケーションのダッシュボードのURLで確認できます。
レスポンス
string
呼び出しが成功したかどうかを示します。成功した場合は
success、失敗した場合は error です。一般的なエラー
関連項目
- CLI:
squarecloud app stop - SDK:
api.apps.stop()(JavaScript),client.apps.stop()(Python),c.Apps.Stop()(Go)

