批量獲取執行個體狀態資訊。
描述
- 能查詢到的所有可能的執行個體狀態參閱 執行個體狀態表。
- 該介面同時可用於獲取執行個體列表。
請求參數
名稱 | 類型 | 是否必需 | 描述 |
---|---|---|---|
Action | String | 是 | 系統規定參數。取值:DescribeInstanceStatus |
RegionId | String | 是 | 執行個體所屬的地域 ID。您可以調用 DescribeRegions 查看最新的阿里雲地域列表。 |
ZoneId | String | 否 | 執行個體所屬可用性區域 |
PageNumber | Integer | 否 | 執行個體狀態列表的頁碼。起始值:1 預設值:1 |
PageSize | Integer | 否 | 分頁查詢時設定的每頁行數。取值範圍:[1, 50] 預設值: 10 |
返回參數
名稱 | 類型 | 描述 |
---|---|---|
TotalCount | Integer | 執行個體總個數 |
PageNumber | Integer | 執行個體列表的頁碼 |
PageSize | Integer | 輸入時設定的每頁行數 |
InstanceStatuses | Array | 執行個體狀態集類型(InstanceStatusSetType ) |
樣本
請求樣本
https://ecs.aliyuncs.com/?Action=DescribeInstanceStatus
&RegionId=cn-hangzhou
&<公共請求參數>
返回樣本
XML 格式
<DescribeInstanceStatusResponse>
<RequestId>6EF60BEC-0242-43AF-BB20-270359FB54A7</RequestId>
<TotalCount>2</TotalCount>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<InstanceStatuses>
<InstanceStatus>
<InstanceId>i-instance1</InstanceId>
<Status>Running</Status>
</InstanceStatus>
<InstanceStatus>
<InstanceId>i-ae4r89pp</InstanceId>
<Status>Stopped</Status>
</InstanceStatus>
</InstanceStatuses>
</DescribeInstanceStatusResponse>
JSON 格式
{
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"TotalCount": 2,
"PageNumber": 1,
"PageSize": 10,
"InstanceStatuses": {
"InstanceStatus": [{
"InstanceId": "i-instance1",
"Status": "Running"
},
{
"InstanceId": "i-ae4r89pp",
"Status": "Stopped"
}]
}
}
錯誤碼
以下為本介面特有的錯誤碼。更多錯誤碼,請訪問 API 錯誤中心。
錯誤碼 | 錯誤資訊 | HTTP 狀態碼 | 說明 |
---|---|---|---|
InvalidRegionId.NotFound | The specified RegionId does not exist. | 404 | 指定的 RegionId 不存在。 |
InvalidZoneId.NotFound | The ZoneId provided does not exist in our records. | 404 | 指定的 ZoneId 不存在。 |