全部产品
云服务器 ECS

DescribeInstanceStatus

更新时间:2017-09-12 17:11:01   分享:   

描述

批量获取当前用户所有实例的状态信息。

  • 能查询到的所有可能的实例状态参阅实例状态表
  • 该接口同时可用于获取实例列表。

请求参数

名称 类型 是否必须 描述
Action String 系统规定参数。取值:DescribeInstanceStatus
RegionId String 实例所属的 Region ID。Region ID 的列表详见 地域列表 或者通过 API 接口 DescribeRegions 查看完整的地域列表。
ZoneId String 实例所属可用区
PageNumber Integer 实例状态列表的页码。起始值:1
默认值:1
PageSize Integer 分页查询时设置的每页行数。取值范围:[1, 50]
默认值: 10

返回参数

名称 类型 描述
TotalCount Integer 实例总个数
PageNumber Integer 实例列表的页码
PageSize Integer 输入时设置的每页行数
InstanceStatuses InstanceStatusSetType 由 InstanceStatusItemType 组成的数组格式,返回实例的状态信息

错误码

错误代码 描述 Http 状态码 语义
InvalidRegionId.NotFound The specified RegionId does not exist. 404 指定的 RegionId 不存在。
InvalidZoneId.NotFound The ZoneId provided does not exist in our records. 404 指定的 ZoneId 不存在。

示例

请求示例

  1. https://ecs.aliyuncs.com/?Action=DescribeInstanceStatus
  2. &RegionId=cn-hangzhou
  3. &<公共请求参数>

返回示例

XML格式

  1. <DescribeInstanceStatusResponse>
  2. <RequestId>6EF60BEC-0242-43AF-BB20-270359FB54A7</RequestId>
  3. <TotalCount>2</TotalCount>
  4. <PageNumber>1</PageNumber>
  5. <PageSize>10</PageSize>
  6. <InstanceStatuses>
  7. <InstanceStatus>
  8. <InstanceId>i-instance1</InstanceId>
  9. <Status>Running</Status>
  10. </InstanceStatus>
  11. <InstanceStatus>
  12. <InstanceId>i-ae4r89pp</InstanceId>
  13. <Status>Stopped</Status>
  14. </InstanceStatus>
  15. </InstanceStatuses>
  16. </DescribeInstanceStatusResponse>

JSON格式

  1. {
  2. "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
  3. "TotalCount": 2,
  4. "PageNumber": 1,
  5. "PageSize": 10,
  6. "InstanceStatuses": {
  7. "InstanceStatus": [{
  8. "InstanceId": "i-instance1",
  9. "Status": "Running"
  10. },
  11. {
  12. "InstanceId": "i-ae4r89pp",
  13. "Status": "Stopped"
  14. }]
  15. }
  16. }
本文导读目录
本文导读目录
以上内容是否对您有帮助?