DescribeInstances
最近更新时间: 2024-12-21 13:01:31
1. 接口描述
接口请求域名： cvm.api3.gsesgpucloud.com。
本接口 (DescribeInstances) 用于查询一个或多个实例的详细信息。
- 可以根据实例
ID、实例名称或者实例计费模式等信息来查询实例的详细信息。过滤信息详细请见过滤器Filter。 - 如果参数为空，返回当前用户一定数量（
Limit所指定的数量，默认为20）的实例。
默认接口请求频率限制：20次/秒。
接口更新时间：2022-10-25 19:54:05。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeInstances |
| Version | 是 | 否 | String | 公共参数，本接口取值：2017-03-12 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceIds | 否 | 否 | Array of String | 按照一个或者多个实例ID查询。实例ID形如：ins-11112222。此参数的具体格式可参考API简介的id.N一节）。每次请求的实例的上限为100。参数不支持同时指定InstanceIds和Filters。示例值： ['ins-rf6ogz49'] |
| Filters | 否 | 否 | Array of Filter | 过滤条件，详见下表：实例过滤条件表。每次请求的Filters的上限为10，Filter.Values的上限为5。参数不支持同时指定InstanceIds和Filters。zone按照【可用区】进行过滤。可用区形如：ap-guangzhou-1。类型：String必选：否可选项：可用区列表project-id按照【项目ID】进行过滤，可通过调用DescribeProject查询已创建的项目列表或登录控制台进行查看；也可以调用AddProject创建新的项目。项目ID形如：1002189。类型：Integer必选：否host-id按照【CDH ID】进行过滤。CDH ID形如：host-xxxxxxxx。类型：String必选：否vpc-id按照【VPC ID】进行过滤。VPC ID形如：vpc-xxxxxxxx。类型：String必选：否subnet-id按照【子网ID】进行过滤。子网ID形如：subnet-xxxxxxxx。类型：String必选：否instance-id按照【实例ID】进行过滤。实例ID形如：ins-61dyt49hxxxx。类型：String必选：否security-group-id按照【安全组ID】进行过滤。安全组ID形如: sg-8jlk3f3r。类型：String必选：否instance-name按照【实例名称】进行过滤。类型：String必选：否instance-charge-type按照【实例计费模式】进行过滤。(POSTPAID_BY_HOUR：表示后付费，即按量计费 |
| Offset | 否 | 否 | Int64 | 偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。示例值： 1 |
| Limit | 否 | 否 | Int64 | 返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。示例值： 5 |
| InnerVpcIds | 否 | 否 | Array of Int64 | 内部参数，数字型vpcId列表 。 示例值： NA |
| InnerSubnetIds | 否 | 否 | Array of Int64 | 内部参数，数字型subnetId列表。 示例值： NA |
| IpAddresses | 否 | 否 | Array of String | 内部参数，精确内外网IP列表。 示例值： NA |
| VagueIpAddress | 否 | 否 | String | 内部参数，模糊内外网IP。 示例值： NA |
| VagueInstanceName | 否 | 否 | String | 内部参数，模糊实例别名。 示例值： NA |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Int64 | 符合条件的实例数量。 示例值： 1 |
| InstanceSet | Instance | 实例详细信息列表。 示例值：查看 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidFilter | 无效的过滤器。 |
| InvalidParameterValue | 无效参数值。参数值格式错误或者参数值不被支持等。 |
| InvalidFilterValue.LimitExceeded | Filter参数值数量超过限制。 |
| InternalServerError | 操作内部错误。 |
| InvalidParameterValue.LimitExceeded | 参数值数量超过限制。 |
| InvalidHostId.Malformed | 无效CDH ID。指定的CDH ID格式错误。例如ID长度错误host-1122。 |
| InvalidInstanceId.Malformed | 无效实例ID。指定的实例ID格式错误。例如实例ID长度错误ins-1122。 |
| InvalidParameter | 无效参数。参数不合要求或者参数不被支持等。 |
| InvalidZone.MismatchRegion | 指定的zone不存在。 |