获取应用实例列表。
调试
您可以在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
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。