アプリケーションインスタンスのリストを取得します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
sae:DescribeApplicationInstances |
get |
*All Resource
|
なし | なし |
リクエスト構文
GET /pop/v1/sam/app/describeApplicationInstances HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| AppId |
string |
必須 |
アプリケーション ID。 |
d700e680-aa4d-4ec1-afc2-6566b5ff**** |
| GroupId |
string |
必須 |
アプリケーショングループの ID。 DescribeApplicationGroups 操作を呼び出して ID を取得します。 |
b2a8a925-477a-4ed7-b825-d5e22500**** |
| CurrentPage |
integer |
任意 |
返すページ番号。 |
1 |
| PageSize |
integer |
任意 |
各ページで返すエントリ数。 デフォルト値：10。 有効値の範囲は (0, 1000000000) です。 |
10 |
| Reverse |
boolean |
任意 |
アプリケーションインスタンスのソート順を指定します。 インスタンスは、まず実行ステータスでソートされ、次にインスタンス ID でソートされます。 有効値：
昇順のインスタンスステータス：
|
true |
| InstanceId |
string |
任意 |
アプリケーションインスタンス ID。 |
demo-faaca66c-5959-45cc-b3bf-d26093b2e9c0****** |
| PipelineId |
string |
任意 |
バッチ ID。 DescribeChangeOrder 操作を呼び出して ID を取得します。 |
85750d48-6cfc-4dbf-8ea0-840397****** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
返されるデータ。 |
||
| RequestId |
string |
リクエスト ID。 |
91F93257-7A4A-4BD3-9A7E-2F6EAE6D**** |
| Message |
string |
リクエストに対して返されるメッセージ。 |
success |
| TraceId |
string |
リクエスト詳細のクエリに使用されるトレース ID。 |
0a98a02315955564772843261e**** |
| Data |
object |
アプリケーションインスタンスに関する情報。 |
|
| CurrentPage |
integer |
現在のページ番号。 |
1 |
| TotalSize |
integer |
インスタンスの総数。 |
10 |
| PageSize |
integer |
1 ページあたりに返されるエントリ数。 |
10 |
| Instances |
array<object> |
アプリケーションインスタンスのリスト。 |
|
|
array<object> |
アプリケーションインスタンスの詳細。 |
||
| CreateTimeStamp |
integer |
インスタンス作成が開始された時刻。 単位：ミリ秒。 |
1558442609000 |
| VSwitchId |
string |
インスタンスがデプロイされている vSwitch の ID。 |
vsw-*** |
| InstanceContainerStatus |
string |
インスタンスコンテナのステータス。 有効値：
|
Running |
| InstanceHealthStatus |
string |
インスタンスのヘルスチェックステータス。 有効値：
|
WithoutHealthCheckConfig |
| InstanceContainerRestarts |
integer |
インスタンスのコンテナが再起動した回数。 |
0 |
| GroupId |
string |
インスタンスが属するグループの ID。 |
b2a8a925-477a-4ed7-b825-d5e22500**** |
| InstanceContainerIp |
string |
インスタンスの内部 IP アドレス。 |
192.168.X.X |
| InstanceId |
string |
インスタンス ID。 |
b2a8a925-477a-4ed7-b825-d5e22500**** |
| ImageUrl |
string |
コンテナイメージの URL。 説明
JAR または WAR パッケージを使用してアプリケーションをデプロイする場合、SAE によって生成されたコンテナイメージはダウンロードできません。 |
registry-vpc.cn-beijing.aliyuncs.com/sae-demo-image/cartservice:1.0 |
| PackageVersion |
string |
デプロイメントパッケージのバージョン。 |
1609939496200 |
| Timestamp |
integer |
タイムスタンプ。 |
1750061980000 |
| Eip |
string |
Elastic IP アドレス (EIP)。 |
8.129.XX.XXX |
| FinishTimeStamp |
integer |
インスタンス作成が完了した時刻。 単位：ミリ秒。 |
1642757283000 |
| DebugStatus |
boolean |
インスタンスがデバッグ中かどうか。 有効値：
|
False |
| SidecarContainersStatus |
array<object> |
サイドカーコンテナのステータス。 |
|
|
object |
サイドカーコンテナのステータス。 |
||
| ContainerId |
string |
サイドカーコンテナの ID。 |
sidecar-test-01 |
| ContainerStatus |
string |
コンテナのステータス。 |
Running |
| ImageUrl |
string |
コンテナイメージの URL。 |
registry.cn-beijing.aliyuncs.com/sae-dev-test/****** |
| MainContainerStatus |
string |
メインコンテナのステータス。 |
Running |
| UnhealthyMessage |
string |
アプリケーションインスタンスのヘルスチェック失敗のエラーメッセージ。 チェックが成功した場合、このフィールドは空です。 |
|
| TrafficStatus |
string |
インスタンスのトラフィックステータス。 |
|
| Tags |
array<object> |
インスタンスにアタッチされたタグ。 |
|
|
object |
|||
| Key |
string |
タグキー。 |
|
| Value |
string |
タグ値。 |
|
| ErrorCode |
string |
エラーコード。 有効値：
|
|
| Code |
string |
HTTP ステータスコードまたは POP エラーコード。 有効値：
|
200 |
| Success |
boolean |
リクエストが成功したかどうかを示します。 有効値：
|
true |
例
成功レスポンス
JSONJSON
{
"RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
"Message": "success",
"TraceId": "0a98a02315955564772843261e****",
"Data": {
"CurrentPage": 1,
"TotalSize": 10,
"PageSize": 10,
"Instances": [
{
"CreateTimeStamp": 1558442609000,
"VSwitchId": "vsw-***",
"InstanceContainerStatus": "Running",
"InstanceHealthStatus": "WithoutHealthCheckConfig",
"InstanceContainerRestarts": 0,
"GroupId": "b2a8a925-477a-4ed7-b825-d5e22500****",
"InstanceContainerIp": "192.168.X.X",
"InstanceId": "b2a8a925-477a-4ed7-b825-d5e22500****",
"ImageUrl": "registry-vpc.cn-beijing.aliyuncs.com/sae-demo-image/cartservice:1.0",
"PackageVersion": "1609939496200",
"Timestamp": 1750061980000,
"Eip": "8.129.XX.XXX",
"FinishTimeStamp": 1642757283000,
"DebugStatus": true,
"SidecarContainersStatus": [
{
"ContainerId": "sidecar-test-01",
"ContainerStatus": "Running",
"ImageUrl": "registry.cn-beijing.aliyuncs.com/sae-dev-test/******"
}
],
"MainContainerStatus": "Running",
"UnhealthyMessage": "",
"TrafficStatus": "",
"Tags": [
{
"Key": "",
"Value": ""
}
]
}
]
},
"ErrorCode": "",
"Code": "200",
"Success": true
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。