擷取應用執行個體列表。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
sae:DescribeApplicationInstances |
get |
*全部資源
|
無 | 無 |
請求文法
GET /pop/v1/sam/app/describeApplicationInstances HTTP/1.1
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| AppId |
string |
是 |
應用 ID。 |
d700e680-aa4d-4ec1-afc2-6566b5ff**** |
| GroupId |
string |
是 |
應用分組 ID。需要調用 DescribeApplicationGroups 介面擷取。 |
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 介面擷取。 |
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 |
分頁查詢時設定的每頁數量。 |
10 |
| Instances |
array<object> |
應用執行個體列表。 |
|
|
array<object> |
應用執行個體列表。 |
||
| CreateTimeStamp |
integer |
執行個體開始建立的時間戳記。單位:毫秒。 |
1558442609000 |
| VSwitchId |
string |
執行個體所在可用性區域。 |
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 |
鏡像倉庫地址。 說明
如果您是通過 JAR 包或 WAR 包部署,那麼由 SAE 平台所產生的鏡像不對外開放下載。 |
registry-vpc.cn-beijing.aliyuncs.com/sae-demo-image/cartservice:1.0 |
| PackageVersion |
string |
版本資訊。 |
1609939496200 |
| Timestamp |
integer |
時間戳記。 |
1750061980000 |
| Eip |
string |
彈性公網 IP。 |
8.129.XX.XXX |
| FinishTimeStamp |
integer |
執行個體建立完成的時間戳記。單位:毫秒。 |
1642757283000 |
| DebugStatus |
boolean |
執行個體是否在調試中。取值說明如下:
|
False |
| SidecarContainersStatus |
array<object> |
Sidecar 容器狀態資訊。 |
|
|
object |
Sidecar 容器狀態資訊。 |
||
| ContainerId |
string |
Sidecar 容器 ID。 |
sidecar-test-01 |
| ContainerStatus |
string |
容器狀態。 |
Running |
| ImageUrl |
string |
鏡像地址。 |
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 |
介面狀態或 POP 錯誤碼。取值說明如下:
|
200 |
| Success |
boolean |
擷取應用執行個體列表是否成功。取值說明如下:
|
true |
樣本
正常返回樣本
JSON格式
{
"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
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。