DescribeApplicationInstances
调用DescribeApplicationInstances接口获取应用实例列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。更多信息,请参见公共请求和返回头。
请求语法
GET /pop/v1/sam/app/describeApplicationInstances HTTP/1.1
请求参数
名称 |
类型 |
位置 |
是否必选 |
示例值 |
描述 |
AppId | String | Query | 是 | d700e680-aa4d-4ec1-afc2-6566b5ff**** | 应用ID。 |
GroupId | String | Query | 是 | b2a8a925-477a-4ed7-b825-d5e22500**** | 应用分组ID。需要调用DescribeApplicationGroups接口获取。 |
CurrentPage | Integer | Query | 否 | 1 | 当前页码。 |
PageSize | Integer | Query | 否 | 10 | 分页查询时设置的每页行数。默认为10,取值范围(0,1000000000)。 |
Reverse | Boolean | Query | 否 | true | 根据应用实例运行状态对其进行排序。如果状态相同,则按照实例ID排序。取值说明如下:
实例正序排列如下: 1. Error:实例启动过程中出错。 2. CrashLoopBackOff:容器无法启动,在启动过程中出错,重启后又出错。 3. ErrImagePull:拉取实例中的容器镜像出错。 4. ImagePullBackOff:无法获取容器镜像。 5. Pending:实例等待调度中。 6. Unknown:未知异常。 7. Terminating:终止实例接入中。 8. NotFound:无法找到实例。 9. PodInitializing:实例初始化中。 10. Init:0/1:实例初始化。 11. Running:实例运行中。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
RequestId | String | 91F93257-7A4A-4BD3-9A7E-2F6EAE6D**** | 请求ID。 |
Message | String | success | 调用结果的附加信息。 |
TraceId | String | 0a98a02315955564772843261e**** | 调用链ID,用于精确查询调用信息。 |
Data | Object | 应用实例信息。 |
|
CurrentPage | Integer | 1 | 当前页码。 |
TotalSize | Integer | 10 | 实例总数。 |
PageSize | Integer | 10 | 分页查询时设置的每页数量。 |
Instances | Array of Instance | 应用实例列表。 |
|
CreateTimeStamp | Long | 1558442609000 | 实例开始创建的时间戳。单位:毫秒。 |
VSwitchId | String | vsw-*** | 实例所在可用区。 |
InstanceContainerStatus | String | Running | 实例运行状态。取值说明如下:
|
InstanceHealthStatus | String | WithoutHealthCheckConfig | 健康检查配置信息。取值说明如下:
|
InstanceContainerRestarts | Long | 0 | 实例重启次数。 |
GroupId | String | b2a8a925-477a-4ed7-b825-d5e22500**** | 实例所属分组ID。 |
InstanceContainerIp | String | 192.168.X.X | 实例内网IP。 |
InstanceId | String | b2a8a925-477a-4ed7-b825-d5e22500**** | 实例ID。 |
ImageUrl | String | registry-vpc.cn-beijing.aliyuncs.com/sae-demo-image/cartservice:1.0 | 镜像仓库地址。 说明 如果您是通过JAR包或WAR包部署,那么由SAE平台所生成的镜像不对外开放下载。 |
PackageVersion | String | 1609939496200 | 版本信息。 |
Eip | String | 8.129.XX.XXX | 弹性公网IP。 |
FinishTimeStamp | Long | 1642757283000 | 实例创建完成的时间戳。单位:毫秒。 |
DebugStatus | Boolean | False | 实例是否在调试中。取值说明如下:
|
ErrorCode | String | 空 | 错误码。取值说明如下:
|
Code | String | 200 | 接口状态或POP错误码。取值说明如下:
|
Success | Boolean | true | 获取应用实例列表是否成功。取值说明如下:
|
示例
请求示例
GET /pop/v1/sam/app/describeApplicationInstances?AppId=d700e680-aa4d-4ec1-afc2-6566b5ff****&GroupId=b2a8a925-477a-4ed7-b825-d5e22500****&CurrentPage=1&PageSize=10&Reverse=true HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeApplicationInstancesResponse>
<RequestId>91F93257-7A4A-4BD3-9A7E-2F6EAE6D****</RequestId>
<Message>success</Message>
<TraceId>0a98a02315955564772843261e****</TraceId>
<Data>
<CurrentPage>1</CurrentPage>
<TotalSize>10</TotalSize>
<PageSize>10</PageSize>
<Instances>
<CreateTimeStamp>1558442609000</CreateTimeStamp>
<VSwitchId>vsw-***</VSwitchId>
<InstanceContainerStatus>Running</InstanceContainerStatus>
<InstanceHealthStatus>WithoutHealthCheckConfig</InstanceHealthStatus>
<InstanceContainerRestarts>0</InstanceContainerRestarts>
<GroupId>b2a8a925-477a-4ed7-b825-d5e22500****</GroupId>
<InstanceContainerIp>192.168.X.X</InstanceContainerIp>
<InstanceId>b2a8a925-477a-4ed7-b825-d5e22500****</InstanceId>
<ImageUrl>registry-vpc.cn-beijing.aliyuncs.com/sae-demo-image/cartservice:1.0</ImageUrl>
<PackageVersion>1609939496200</PackageVersion>
<Eip>8.129.XX.XXX</Eip>
<FinishTimeStamp>1642757283000</FinishTimeStamp>
<DebugStatus>false</DebugStatus>
</Instances>
</Data>
<Code>200</Code>
<Success>true</Success>
</DescribeApplicationInstancesResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/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",
"Eip" : "8.129.XX.XXX",
"FinishTimeStamp" : 1642757283000,
"DebugStatus" : false
} ]
},
"Code" : "200",
"Success" : true
}
错误码
访问错误中心查看更多错误码。