アプリケーション情報の取得
GET /v2/apps/:app_id でアプリケーションのメタデータを取得します: 名前、オーナー、クラスター、割り当て RAM、言語、ドメイン。workspace で共有されたアプリにも使えます。
GET
アプリケーション情報の取得
apps:read スコープを持つ API キーが必要です。
このエンドポイントは、アプリケーションの名前、所有者、cluster、割り当てられた RAM、プログラミング言語、DNS 設定といった、アプリケーションの識別情報と構成を返します。アプリケーションに対して操作を行う前に、そのメタデータを確認したい場合、例えばどの cluster で稼働しているか、どのサブドメインでアクセスできるかを確認したい場合に呼び出すエンドポイントです。
アクセス範囲は呼び出し元に応じて決まります。アプリケーションが所属している workspace のメンバーであれば、追加のパラメータなしで自動的に取得できます。静的なメタデータではなくライブのリソース使用状況が必要な場合は アプリケーションのステータス取得 を、アカウント全体で設定済みのホスト名を確認したい場合は ドメイン一覧の取得 を参照してください。
パラメータ
string
必須
アプリケーションの ID。アプリケーションのダッシュボードの URL から確認できます。
レスポンス
string
呼び出しが成功したかどうかを示します。成功した場合は
success、失敗した場合は error です。object
レスポンスの内容。
関連項目
- CLI:
squarecloud app info - SDK:
api.apps.get()(JavaScript),client.apps.get()(Python),c.Apps.Get()(Go)

