查询实例状态
描述
批量获取当前用户所有实例的状态信息,也可用于获取实例列表,详见实例状态表;
借助 RAM 实现授权访问资源操作时的特殊限制
只允许查询前 100 个实例的状态;如果 PageNumber、PageSize 组合出的值超过了此限制,请求会被拒绝,错误码为:Forbidden.AccessTooManyOthersResource。
Response中,TotalCount 表示:ResourceOwner 的所有实例中,有多少实例被授予了调用者进行该操作。当个数超过 100 个时,TotalCount 取值为 100。
请求参数
名称 |
类型 |
是否必须 |
描述 |
Action
String
是
操作接口名,系统规定参数,取值:DescribeInstanceStatus
RegionId
String
是
实例所属于的 Region ID
ZoneId
String
否
实例所属可用区
PageNumber
Integer
否
实例状态列表的页码,起始值为 1,默认值为 1
PageSize
Integer
否
分页查询时设置的每页行数,最大值 50 行,默认值为 10
返回参数
名称 |
类型 |
描述 |
TotalCount
Integer
实例总个数
PageNumber
Integer
实例列表的页码
PageSize
Integer
输入时设置的每页行数
InstanceStatuses
InstanceStatusSetType
由 InstanceStatusItemType 组成的数组格式,返回实例的状态信息
错误码
错误代码 |
描述 |
Http 状态码 |
语义 |
MissingParameter
The input parameter "RegionId" that is mandatory for processing this request is not supplied.
400
缺少 RegionId 值
InvalidParameter
The specified parameter "PageNumber" is not valid.
400
指定的 PageNumber 不合法(不是数字)
InvalidParameter
The specified parameter "PageSize" is not valid.
400
指定的 PageSize 不合法(不是数字或超出范围)
示例
请求示例
https://ecs.aliyuncs.com/?Action=DescribeInstanceStatus
&RegionId=cn-hangzhou
&<公共请求参数>
返回示例
XML格式
6EF60BEC-0242-43AF-BB20-270359FB54A7
2
1
10
i-instance1
Running
i-ae4r89pp
Stopped
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"
}]
}
}
所属专题: