查询子网列表
最近更新时间: 2024-10-18 10:38:43
1. 接口描述
接口请求域名： vpc.api3.fincloud.tencent.cn。
本接口（DescribeSubnets）用于查询子网列表。
默认接口请求频率限制：100次/秒。
接口更新时间：2022-10-24 19:51:19。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeSubnets |
| Version | 是 | 否 | String | 公共参数，本接口取值：2017-03-12 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| SubnetIds | 否 | 否 | Array of String | 子网实例ID查询。形如：subnet-pxir56ns。每次请求的实例的上限为100。参数不支持同时指定SubnetIds和Filters。 |
| Filters | 否 | 否 | Array of Filter | 过滤条件，参数不支持同时指定SubnetIds和Filters。<br><li>subnet-id - String - （过滤条件）Subnet实例名称。</li><br><li>type - Int - （过滤条件）Subnet类型，默认普通子网。</li><br><li>vpc-id - String - （过滤条件）VPC实例ID，形如：vpc-f49l6u0z。</li><br><li>cidr-block - String - （过滤条件）子网网段，形如: 192.168.1.0 。</li><br><li>is-default - Boolean - （过滤条件）是否是默认子网。</li><br><li>is-remote-vpc-snat - Boolean - （过滤条件）是否为VPC SNAT地址池子网。</li><br><li>subnet-name - String - （过滤条件）子网名称。</li><br><li>zone - String - （过滤条件）可用区。</li><br><li>tag-key - String -是否必填：否- （过滤条件）按照标签键进行过滤。</li><br><li>tag:tag-key - String - 是否必填：否 - （过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。使用请参考示例2。</li> |
| Offset | 否 | 否 | String | 偏移量，默认为0。 |
| Limit | 否 | 否 | String | 返回数量，默认为20，最大值为100。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Uint64 | 此参数对外不可见。 符合条件的实例数量。 |
| SubnetSet | Subnet | 此参数对外不可见。 子网对象。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.Coexist | |
| InvalidParameterValue.Malformed | |
| ResourceNotFound |