云服务器查看实例状态列表

说明：
当前页面接口为旧版 API，未来可能停止维护，目前不展示在左侧导航。云服务器 API 3.0 版本接口定义更加规范，访问时延下降显著，建议使用 云服务器 API 3.0。
1. 接口描述
本接口 (DescribeInstancesStatus) 用于查询一个或多个实例的状态。
接口请求域名：cvm.api.qcloud.com
可以根据实例ID来查询实例的状态。
如果参数为空，返回当前用户一定数量（Limit 所指定的数量，默认为20）的实例状态。
2. 输入参数
以下请求参数列表仅列出了接口请求参数，其它参数见 公共请求参数 页面。
参数名称
类型
是否必选
描述
Version
String
是
表示 API 版本号，主要用于标识请求的不同 API 版本。 本接口第一版本可传：2017-03-12。
InstanceIds.N
array of Strings
否
按照一个或者多个实例 ID 查询。实例 ID 形如：ins-11112222。此参数的具体格式可参考 API 简介 的id.N一节。每次请求的实例的上限为100。
Offset
Integer
否
偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介 中的相关小节。
Limit
Integer
否
返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介 中的相关小节。
3. 输出参数
参数名称
类型
描述
RequestId
String
唯一请求 ID。每次请求都会返回RequestId。当用户调用接口失败找后台研发人员处理时需提供该RequestId。
TotalCount
Integer
符合条件的实例状态数量。
InstanceStatusSet
array of InstanceStatus objects
实例状态列表。
4. 错误码
以下错误码表仅列出了该接口的业务逻辑错误码，更多错误码详见 公共错误码。
错误码
描述
InvalidParameterValue
无效参数值。参数值格式错误或者参数值不被支持等。
InvalidInstanceId.Malformed
无效实例ID。指定的实例ID格式错误。例如ID长度错误ins-1122。
InvalidParameterValue.LimitExceeded
参数值数量超过限制。
InternalServerError
内部服务错误。
5. 示例
输入
https://cvm.api.qcloud.com/v2/index.php?Action=DescribeInstancesStatus
&Version=2017-03-12
&InstanceIds.1=ins-r8hr2upy
&InstanceIds.2=ins-5d8a23rs
&Offset=0
&Limit=2
&<公共请求参数>
输出
{
    "Response": {
        "TotalCount": 2,
        "InstanceStatusSet": [
            {
                "InstanceId": "ins-r8hr2upy",
                "InstanceState": "RUNNING"
            },
            {
                "InstanceId": "ins-5d8a23rs",
                "InstanceState": "STOPPED"
            }
        ],
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
    }
}

参数名称	类型	是否必选	描述
Version	String	是	表示 API 版本号，主要用于标识请求的不同 API 版本。本接口第一版本可传：2017-03-12。
InstanceIds.N	array of Strings	否	按照一个或者多个实例 ID 查询。实例 ID 形如：`ins-11112222`。此参数的具体格式可参考 API 简介的`id.N`一节。每次请求的实例的上限为100。
Offset	Integer	否	偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API 简介中的相关小节。
Limit	Integer	否	返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API 简介中的相关小节。

错误码	描述
InvalidParameterValue	无效参数值。参数值格式错误或者参数值不被支持等。
InvalidInstanceId.Malformed	无效实例`ID`。指定的实例`ID`格式错误。例如`ID`长度错误`ins-1122`。
InvalidParameterValue.LimitExceeded	参数值数量超过限制。
InternalServerError	内部服务错误。

查看实例状态列表

本页目录：

1. 接口描述

2. 输入参数

3. 输出参数

4. 错误码

5. 示例