1. 接口描述
接口请求域名： vpc.tencentcloudapi.com 。
本接口（DescribeSubnets）用于查询子网列表。
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeSubnets。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| SubnetIds.N | 否 | Array of String | 子网实例ID查询。形如：subnet-pxir56ns。每次请求的实例的上限为100。参数不支持同时指定SubnetIds和Filters。 示例值：subnet-pxir56ns |
| Filters.N | 否 | Array of Filter | 过滤条件，参数不支持同时指定SubnetIds和Filters。 示例值：vpc-pxir56ns |
| Offset | 否 | String | 偏移量，默认为0。 示例值：0 |
| Limit | 否 | String | 返回数量，默认为20，最大值为100。 示例值：20 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 符合条件的实例数量。 示例值：10 |
| SubnetSet | Array of Subnet | 子网对象。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询子网列表
查询子网列表
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSubnets
<公共请求参数>
{
"Filters": [
{
"Values": [
"vpc-2at5y1pn"
],
"Name": "vpc-id"
},
{
"Values": [
"默认广州二区子网"
],
"Name": "subnet-name"
},
{
"Values": [
"172.16.16.0"
],
"Name": "cidr-block"
},
{
"Values": [
"subnet-otu92seu"
],
"Name": "subnet-id"
},
{
"Values": [
"true"
],
"Name": "is-default"
}
]
}输出示例
{
"Response": {
"SubnetSet": [
{
"NetworkAclId": "",
"RouteTableId": "rtb-n0yr460a",
"VpcId": "vpc-n0yr460a",
"EnableBroadcast": false,
"Zone": "ap-guangzhou",
"Ipv6CidrBlock": "",
"AvailableIpAddressCount": 1,
"IsRemoteVpcSnat": false,
"SubnetName": "子网1",
"TotalIpAddressCount": 1,
"IsCdcSubnet": 0,
"CdcId": "cluster-1234dert",
"TagSet": [
{
"Value": "ck",
"Key": "kc"
}
],
"CreatedTime": "2020-05-25 20:09:07",
"SubnetId": "subnet-bthucmmy",
"CidrBlock": "10.0.0.0/16",
"IsDefault": true
}
],
"TotalCount": 1,
"RequestId": "cccb2665-5d02-4d87-b9e7-757bb06e5beb"
}
}示例2 查询绑定了标签的子网列表
查询绑定了标签的子网列表
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSubnets
<公共请求参数>
{
"Filters": [
{
"Values": [
"shanghai"
],
"Name": "tag:city"
}
]
}输出示例
{
"Response": {
"SubnetSet": [
{
"NetworkAclId": "",
"RouteTableId": "rtb-n0yr460a",
"VpcId": "vpc-n0yr460a",
"EnableBroadcast": false,
"Zone": "ap-guangzhou",
"Ipv6CidrBlock": "2001::85b:3c51:f5ff:ffda",
"AvailableIpAddressCount": 1,
"IsRemoteVpcSnat": false,
"SubnetName": "子网2",
"TotalIpAddressCount": 1,
"IsCdcSubnet": 0,
"CdcId": "cluster-1234dert",
"TagSet": [
{
"Value": "gt",
"Key": "ku"
}
],
"CreatedTime": "2020-05-25 20:09:07",
"SubnetId": "subnet-bthucmmy",
"CidrBlock": "10.0.0.0/16",
"IsDefault": true
}
],
"TotalCount": 1,
"RequestId": "cccb2665-5d02-4d87-b9e7-757bb06e5beb"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.ModuleError | 内部模块错误。 |
| InvalidParameter.Coexist | 参数不支持同时指定。 |
| InvalidParameter.FilterInvalidKey | 指定过滤条件不存在。 |
| InvalidParameter.FilterNotDict | 指定过滤条件不是键值对。 |
| InvalidParameter.FilterValuesNotList | 指定过滤选项值不是列表。 |
| InvalidParameterValue.Empty | 缺少参数。 |
| InvalidParameterValue.LimitExceeded | 参数值超出限制。 |
| InvalidParameterValue.Malformed | 入参格式不合法。 |
| InvalidParameterValue.Range | 参数值不在指定范围。 |
| ResourceNotFound | 资源不存在。 |
| UnsupportedOperation | 操作不支持。 |
| UnsupportedOperation.AppIdMismatch | 资源不在指定的AppId下。 |
