查看实例列表
最近更新时间: 2024-06-18 14:31:29
1. 接口描述
接口请求域名： cvm.api3.fincloud.tencent.cn。
本接口 (DescribeInstances) 用于查询一个或多个实例的详细信息。
- 可以根据实例
ID、实例名称或者实例计费模式等信息来查询实例的详细信息。过滤信息详细请见过滤器Filter。 - 如果参数为空，返回当前用户一定数量（
Limit所指定的数量，默认为20）的实例。
默认接口请求频率限制：20次/秒。
接口更新时间：2022-10-25 19:54:05。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeInstances |
| Version | 是 | 否 | String | 公共参数，本接口取值：2017-03-12 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| InstanceIds | 否 | 否 | Array of String | 按照一个或者多个实例ID查询。实例ID形如：ins-11112222。此参数的具体格式可参考API简介的id.N一节）。每次请求的实例的上限为100。参数不支持同时指定InstanceIds和Filters。 |
| 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-xxxxxxxx。类型：String必选：否security-group-id按照【安全组ID】进行过滤。安全组ID形如: sg-8jlk3f3r。类型：String必选：否instance-name按照【实例名称】进行过滤。类型：String必选：否instance-charge-type按照【实例计费模式】进行过滤。(POSTPAID_BY_HOUR：表示后付费，即按量计费 | CDHPAID：表示CDH付费，即只对CDH计费，不对CDH上的实例计费。)类型：String必选：否instance-state按照【实例状态】进行过滤。PENDING：表示创建中LAUNCH_FAILED：表示创建失败RUNNING：表示运行中STOPPED：表示关机STARTING：表示开机中STOPPING：表示关机中REBOOTING：表示重启中SHUTDOWN：表示停止待销毁TERMINATING：表示销毁中。类型：String必选：否private-ip-address按照【实例主网卡的内网IP】进行过滤。类型：String必选：否public-ip-address按照【实例主网卡的公网IP】进行过滤，包含实例创建时自动分配的IP和实例创建后手动绑定的弹性IP。类型：String必选：否ipv6-address按照【实例的IPv6地址】进行过滤。类型：String必选：否tag-key按照【标签键】进行过滤。类型：String必选：否tag-value按照【标签值】进行过滤。类型：String必选：否tag:tag-key按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。使用请参考示例2。类型：String必选：否。architectures 按照【架构】进行过滤。 类型：String 必选：否 instance-family 按照【主机类型】进行过滤。 类型：String 必选：否 |
| Offset | 否 | 否 | Int64 | 偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。 |
| Limit | 否 | 否 | Int64 | 返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。 |
| InnerVpcIds | 否 | 否 | Array of Int64 | 此参数对外不可见。 内部参数，数字型vpcId列表 。 |
| InnerSubnetIds | 否 | 否 | Array of Int64 | 此参数对外不可见。 内部参数，数字型subnetId列表。 |
| IpAddresses | 否 | 否 | Array of String | 此参数对外不可见。 内部参数，精确内外网IP列表。 |
| VagueIpAddress | 否 | 否 | String | 此参数对外不可见。 内部参数，模糊内外网IP。 |
| VagueInstanceName | 否 | 否 | String | 此参数对外不可见。 内部参数，模糊实例别名。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Int64 | 此参数对外不可见。 符合条件的实例数量。 |
| InstanceSet | Instance | 此参数对外不可见。 实例详细信息列表。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidFilter | |
| InvalidParameterValue | |
| InvalidFilterValue.LimitExceeded | |
| InternalServerError | |
| InvalidParameterValue.LimitExceeded | |
| InvalidHostId.Malformed | |
| InvalidInstanceId.Malformed | |
| InvalidParameter | |
| InvalidZone.MismatchRegion |