DescribeInstanceStatus_实例_API参考_云服务器 ECS-阿里云

描述

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

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

请求参数

名称	类型	是否必需	描述
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	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"
        }]
    }
}

错误码

错误代码	错误信息	HTTP 状态码	说明
InvalidRegionId.NotFound	The specified RegionId does not exist.	404	指定的 RegionId 不存在。
InvalidZoneId.NotFound	The ZoneId provided does not exist in our records.	404	指定的 ZoneId 不存在。

DescribeInstanceStatus

描述

请求参数

返回参数

示例

请求示例

返回示例

错误码

热门反馈