租户端 计算 云服务器（CVM） 实例相关接口 DescribeInstancesStatus

DescribeInstancesStatus

最近更新时间: 2024-12-21 13:01:32

1. 接口描述

接口请求域名： cvm.api3.gsesgpucloud.com。

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

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

默认接口请求频率限制：20次/秒。

接口更新时间：2018-03-21 16:49:07。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeInstancesStatus
Version 是 否 String 公共参数，本接口取值：2017-03-12
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceIds 否 否 Array of String 按照一个或者多个实例ID查询。实例ID形如：ins-11112222。此参数的具体格式可参考API简介的id.N一节）。每次请求的实例的上限为100。
示例值： ["ins-r8hr2upy\r\n","ins-5d8a23rs\r\n"]
Offset 否 否 Int64 偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
示例值： 0
Limit 否 否 Int64 返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
示例值： 2

3. 输出参数

参数名称 类型 描述
TotalCount Int64 符合条件的实例状态数量。
示例值： 2
InstanceStatusSet InstanceStatus 实例状态 列表。
示例值：查看
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

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