查看实例状态列表

最近更新时间:2018-10-12 16:02:47

1. 接口描述

接口请求域名: cvm.tencentcloudapi.com 。

本接口 (DescribeInstancesStatus) 用于查询一个或多个实例的状态。

  • 可以根据实例ID来查询实例的状态。
  • 如果参数为空,返回当前用户一定数量(Limit所指定的数量,默认为20)的实例状态。

默认接口请求频率限制:40次/每秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi )时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cvm.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeInstancesStatus
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
InstanceIds.N Array of String 按照一个或者多个实例ID查询。实例ID形如:ins-11112222。此参数的具体格式可参考API简介id.N一节)。每次请求的实例的上限为100。
Offset Integer 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
Limit Integer 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。

3. 输出参数

参数名称 类型 描述
TotalCount Integer 符合条件的实例状态数量。
InstanceStatusSet Array of InstanceStatus 实例状态 列表。
RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

4. 示例

示例1 查看实例状态列表

输入示例

https://cvm.tencentcloudapi.com/?Action=DescribeInstancesStatus
&InstanceIds.0=ins-r8hr2upy
&InstanceIds.1=ins-5d8a23rs
&Offset=0
&Limit=2
&<公共请求参数>

输出示例

{
  "Response": {
    "InstanceStatusSet": [
      {
        "InstanceId": "ins-r8hr2upy",
        "InstanceState": "RUNNING"
      },
      {
        "InstanceId": "ins-5d8a23rs",
        "InstanceState": "STOPPED"
      }
    ],
    "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7",
    "TotalCount": 2
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、 SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集( SDK ),支持多种编程语言,能更方便的调用 API 。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

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

如果有其他疑问,你也可以通过提问形式与我们联系探讨