DescribeApplicationStatus API を呼び出して、アプリケーションのステータスを取得します。
今すぐお試しください
テスト
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 |
| TraceId |
string |
リクエストの詳細を照会するために使用されるトレース ID。 |
0a98a02315955564772843261e**** |
| Data |
object |
レスポンスデータ。 |
|
| ArmsAdvancedEnabled |
string |
ARMS アドバンストエディションが有効になっているかどうかを示します。 有効な値:
|
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 |
| AppId |
string |
アプリケーション ID。 |
0099b7be-5f5b-4512-a7fc-56049ef1**** |
| LastChangeOrderRunning |
boolean |
最新の変更オーダーが実行中かどうかを示します。 有効な値:
|
false |
| RunningInstances |
integer |
アプリケーションの実行中のインスタンス数。 |
1 |
| LastChangeOrderStatus |
string |
最新の変更オーダーのステータス。 有効な値:
|
SUCCESS |
| SubStatus |
string |
変更オーダーのサブステータス。 このパラメーターは、リリースプロセス中に例外が発生したかどうかを判断するために使用されます。 有効な値:
|
NORMAL |
| EnableAgent |
boolean |
SAE エージェントが有効になっているかどうかを示します。 有効な値:
|
false |
| FileSizeLimit |
integer |
ファイルサイズの制限。 単位:KB。 有効な値:0~10240。 |
10240 |
| ErrorCode |
string |
エラーコード。
|
|
| Code |
string |
HTTP ステータスコード。 有効な値:
|
200 |
| Success |
boolean |
アプリケーションのステータスが取得されたかどうかを示します。 有効な値:
|
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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。