查询VPC下的云主机实例列表
最近更新时间: 2024-09-03 18:49:53
1. 接口描述
接口请求域名： vpc.api3.cloud.sunhongs.com。
本接口（DescribeVpcInstances）用于查询VPC下的云主机实例列表。
默认接口请求频率限制：20次/秒。
接口更新时间：2020-04-08 17:37:19。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeVpcInstances |
| Version | 是 | 否 | String | 公共参数，本接口取值：2017-03-12 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| Filters | 是 | 否 | Array of Filter | 过滤条件，参数不支持同时指定RouteTableIds和Filters。<br><li>vpc-id - String - （过滤条件）VPC实例ID，形如：vpc-f49l6u0z。</li><br><li>instance-id - String - （过滤条件）云主机实例ID。</li><br><li>instance-name - String - （过滤条件）云主机名称。</li> |
| Offset | 否 | 否 | Uint64 | 偏移量。 |
| Limit | 否 | 否 | Uint64 | 请求对象个数。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| InstanceSet | CvmInstance | 此参数对外不可见。 云主机实例列表。 |
| TotalCount | Uint64 | 此参数对外不可见。 满足条件的云主机实例个数。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.Malformed | |
| ResourceNotFound | |
| InvalidParameterValue.Range |