1. 接口描述
接口请求域名： cvm.tencentcloudapi.com 。
本接口 (DescribeInstancesStatus) 用于查询一个或多个实例的状态。
- 可以根据实例
ID来查询实例的状态。 - 如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的实例状态。
默认接口请求频率限制：40次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeInstancesStatus。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceIds.N | 否 | Array of String | 按照一个或者多个实例ID查询。实例ID形如：ins-11112222。此参数的具体格式可参考API简介的ids.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 查看实例状态列表
本示例用于查看实例状态列表中的两个实例。
输入示例
GET https://cvm.tencentcloudapi.com/?Action=DescribeInstancesStatus
&InstanceIds.0=ins-r8hr2upy
&InstanceIds.1=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"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalServerError | 操作内部错误。 |
| InvalidFilter | 无效的过滤器。 |
| InvalidInstanceId.Malformed | 无效实例ID。指定的实例ID格式错误。例如实例ID长度错误ins-1122。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.InstanceIdMalformed | 实例ID不合要求，请提供规范的实例ID，类似ins-xxxxxxxx，字母x代表小写字符或数字。 |
| InvalidParameterValue.LimitExceeded | 参数值数量超过限制。 |
| UnauthorizedOperation.InvalidToken | 请确认Token是否有效。 |
| UnsupportedOperation | 操作不支持。 |