调用DescribeInstanceStatus获取多台ECS实例的状态信息。
接口说明
- ECS实例的生命周期状态请参见实例状态表。
- 该接口同时可用于获取实例列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeInstanceStatus | 系统规定参数。取值:DescribeInstanceStatus |
RegionId | String | 是 | cn-hangzhou | 实例所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。 |
InstanceId.N | RepeatList | 否 | i-bp1j4i2jdf3owlhe**** | 一个或者多个ECS实例ID。N的取值范围:1~100,多个取值使用重复列表的形式。 |
ZoneId | String | 否 | cn-hangzhou-d | 实例所属可用区。 |
ClusterId | String | 否 | cls-bp67acfmxazb4p**** | 实例所属的集群ID。 |
PageNumber | Integer | 否 | 1 | 实例状态列表的页码。 起始值:1 默认值:1 |
PageSize | Integer | 否 | 10 | 分页查询时设置的每页行数。取值范围:1~50 默认值:10 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
InstanceStatuses | Array | 实例状态集类型(InstanceStatus)。 |
|
InstanceStatus | |||
InstanceId | String | i-bp1j4i2jdf3owlhe**** | 实例ID。 |
Status | String | Running | 实例状态。 |
PageNumber | Integer | 1 | 实例列表的页码。 |
PageSize | Integer | 1 | 输入时设置的每页行数。 |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E | 请求ID。 |
TotalCount | Integer | 58 | 实例总个数。 |
示例
请求示例
https://ecs.aliyuncs.com/?Action=DescribeInstanceStatus &RegionId=cn-hangzhou &PageSize=1 &PageNumber=1 &InstanceId.1=i-bp1j4i2jdf3owlhe**** &<公共请求参数>
正常返回示例
XML
格式
<DescribeInstanceStatusResponse> <PageNumber>1</PageNumber> <InstanceStatuses> <InstanceStatus> <Status>Running</Status> <InstanceId>i-bp1j4i2jdf3owlhe****</InstanceId> </InstanceStatus> </InstanceStatuses> <TotalCount>58</TotalCount> <PageSize>1</PageSize> <RequestId>746C3444-9A24-4D7D-B8A8-DCBF7AC8BD66</RequestId> </DescribeInstanceStatusResponse>
JSON
格式
{ "PageNumber": 1, "InstanceStatuses": { "InstanceStatus": [ { "Status": "Running", "InstanceId": "i-bp1j4i2jdf3owlhe****" } ] }, "TotalCount": 58, "PageSize": 1, "RequestId": "746C3444-9A24-4D7D-B8A8-DCBF7AC8BD66" }
错误码
访问错误中心查看更多错误码。