すべてのプロダクト
Search
ドキュメントセンター

Serverless App Engine:DescribeApplicationStatus

最終更新日:Apr 22, 2026

DescribeApplicationStatus API を呼び出して、アプリケーションのステータスを取得します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

sae:DescribeApplicationStatus

get

*All Resource

*

なし なし

リクエスト構文

GET /pop/v1/sam/app/describeApplicationStatus HTTP/1.1

リクエストパラメーター

パラメーター

必須 / 任意

説明

AppId

string

必須

アプリケーションの ID。

0099b7be-5f5b-4512-a7fc-56049ef1****

レスポンスフィールド

フィールド

説明

object

返されるデータ。

RequestId

string

リクエスト ID。

91F93257-7A4A-4BD3-9A7E-2F6EAE6D****

Message

string

レスポンスメッセージ。

  • 呼び出しが成功した場合、success が返されます。

  • 呼び出しが失敗した場合、エラーメッセージが返されます。

success

TraceId

string

リクエストの詳細を照会するために使用されるトレース ID。

0a98a02315955564772843261e****

Data

object

レスポンスデータ。

ArmsAdvancedEnabled

string

ARMS アドバンストエディションが有効になっているかどうかを示します。 有効な値:

  • true:有効。

  • false:無効。

false

LastChangeOrderId

string

最後に実行された変更オーダーの ID。 変更オーダーが実行されなかった場合、または変更オーダーに関する情報が期限切れになった場合、このパラメーターは空になります。

1ccc2339-fc19-49aa-bda0-1e7b8497****

ArmsApmInfo

string

ARMS 内のアプリケーションのメタデータ。

{"appId":"0099b7be-5f5b-4512-a7fc-56049ef1****","licenseKey":"d5cgdt5pu0@7303f55292a****"}

CreateTime

string

アプリケーションが作成された時刻。 この値は UNIX タイムスタンプです。

1563373372746

CurrentStatus

string

アプリケーションの現在のステータス。 有効な値:

  • RUNNING:アプリケーションは実行中です。

  • STOPPED:アプリケーションは停止しています。

  • UNKNOWN:アプリケーションのステータスは不明です。

RUNNING

AppId

string

アプリケーション ID。

0099b7be-5f5b-4512-a7fc-56049ef1****

LastChangeOrderRunning

boolean

最新の変更オーダーが実行中かどうかを示します。 有効な値:

  • true

  • false

false

RunningInstances

integer

アプリケーションの実行中のインスタンス数。

1

LastChangeOrderStatus

string

最新の変更オーダーのステータス。 有効な値:

  • READY:変更オーダーは準備完了です。

  • RUNNING:変更オーダーは実行中です。

  • SUCCESS:変更オーダーは成功しました。

  • FAIL:変更オーダーは失敗しました。

  • ABORT:変更オーダーは中止されました。

  • WAIT_BATCH_CONFIRM:変更オーダーは、次のバッチの手動確認を待機しています。

  • AUTO_BATCH_WAIT:変更オーダーは、自動バッチの待機状態です。

  • SYSTEM_FAIL:システムエラーが発生しました。

  • WAIT_APPROVAL:変更オーダーは承認待ちです。

  • APPROVED:変更オーダーは承認され、実行待ちです。

SUCCESS

SubStatus

string

変更オーダーのサブステータス。 このパラメーターは、リリースプロセス中に例外が発生したかどうかを判断するために使用されます。 有効な値:

  • NORMAL:リリースは正常です。

  • RUNNING_BUT_HAS_ERROR:リリースは異常です。 たとえば、段階的リリース中にエラーが発生した場合、手動でリリースをロールバックする必要があります。 この場合、変更オーダーは完了できず、変更オーダーのステータスは RUNNING のままになります。

NORMAL

EnableAgent

boolean

SAE エージェントが有効になっているかどうかを示します。 有効な値:

  • true

  • false

false

FileSizeLimit

integer

ファイルサイズの制限。 単位:KB。 有効な値:0~10240。

10240

ErrorCode

string

エラーコード。

  • リクエストが成功した場合、このパラメーターは返されません。

  • リクエストが失敗した場合、このパラメーターが返されます。 詳細については、このトピックの「エラーコード」セクションをご参照ください。

Code

string

HTTP ステータスコード。 有効な値:

  • 2xx:リクエストは成功しました。

  • 3xx:リクエストはリダイレクトされました。

  • 4xx:リクエストは無効でした。

  • 5xx:サーバーエラーが発生しました。

200

Success

boolean

アプリケーションのステータスが取得されたかどうかを示します。 有効な値:

  • true

  • false

true

成功レスポンス

JSONJSON

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "ArmsAdvancedEnabled": "false",
    "LastChangeOrderId": "1ccc2339-fc19-49aa-bda0-1e7b8497****",
    "ArmsApmInfo": "{\"appId\":\"0099b7be-5f5b-4512-a7fc-56049ef1****\",\"licenseKey\":\"d5cgdt5pu0@7303f55292a****\"}",
    "CreateTime": "1563373372746",
    "CurrentStatus": "RUNNING",
    "AppId": "0099b7be-5f5b-4512-a7fc-56049ef1****",
    "LastChangeOrderRunning": false,
    "RunningInstances": 1,
    "LastChangeOrderStatus": "SUCCESS",
    "SubStatus": "NORMAL",
    "EnableAgent": false,
    "FileSizeLimit": 10240
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidApplication.NotFound The current application does not exist.
400 InvalidParameter.NotEmpty You must specify the parameter %s.
404 InvalidAppId.NotFound The specified AppId does not exist.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。