1. 接口描述
接口请求域名： ecm.tencentcloudapi.com 。
查询子网列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeSubnets。 |
| Version | 是 | String | 公共参数，本接口取值：2019-07-19。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| SubnetIds.N | 否 | Array of String | 子网实例ID查询。形如：subnet-pxir56ns。每次请求的实例的上限为100。参数不支持同时指定SubnetIds和Filters。 |
| Filters.N | 否 | Array of Filter | 过滤条件，参数不支持同时指定SubnetIds和Filters。 subnet-id - String - Subnet实例名称。 subnet-name - String - 子网名称。只支持单值的模糊查询。 cidr-block - String - 子网网段，形如: 192.168.1.0 。只支持单值的模糊查询。 vpc-id - String - VPC实例ID，形如：vpc-f49l6u0z。 vpc-cidr-block - String - vpc网段，形如: 192.168.1.0 。只支持单值的模糊查询。 region - String - ECM地域 zone - String - 可用区。 tag-key - String -是否必填：否- 按照标签键进行过滤。 ipv6-cidr-block- String - 是否必填：否 - 按照IPv6 CIDR进行过滤。 isp-type - String - 是否必填：否 - 按照运营商类型( 如CMCC，CUCC， CTCC)进行过滤。 |
| Offset | 否 | String | 偏移量 示例值：10 |
| Limit | 否 | String | 返回数量 示例值：10 |
| EcmRegion | 否 | String | ECM 地域 示例值：ap-hefei-ecm |
| Sort | 否 | String | 排序方式：time时间倒序, default按照网络规划排序 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 符合条件的实例数量。 示例值：10 |
| SubnetSet | Array of Subnet | 子网对象。 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询子网列表
查询子网列表
输入示例
https://ecm.tencentcloudapi.com/?Action=DescribeSubnets
&Filters.0.Name=subnet-id
&Filters.0.Values.0=subnet-ae71tjp6
&EcmRegion=ap-hangzhou-ecm
&<公共请求参数>输出示例
{
"Response": {
"SubnetSet": [
{
"NetworkAclId": "",
"ISPType": "CMCC",
"RouteTableId": "rtb-cahjl2qq",
"VpcId": "vpc-hqhu0suj",
"EnableBroadcast": false,
"Zone": "ap-hangzhou-ecm-1",
"Ipv6CidrBlock": "",
"Region": "ap-hangzhou-ecm",
"SubnetName": "subnet_test",
"AvailableIpAddressCount": 253,
"IsRemoteVpcSnat": false,
"SubnetId": "subnet-ae71tjp6",
"InstanceCount": 0,
"VpcCidrBlock": "192.168.0.0/18",
"TagSet": [
{
"Value": "hangzhou",
"Key": "city"
}
],
"CreatedTime": "2020-08-14 11:38:33",
"ZoneName": "杭州一区",
"CidrBlock": "192.168.1.0/24",
"IsDefault": false,
"VpcIpv6CidrBlock": ""
}
],
"TotalCount": 1,
"RequestId": "6e863039-2a22-4a98-8577-93823b250674"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.InternalOperationFailure | 内部操作错误。 |
| InvalidParameter.Coexist | 参数不支持同时指定。 |
| InvalidParameter.InvalidDataFormat | 数据格式不正确。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.FilterLimitExceeded | Filter参数数值超过限制。 |
| InvalidParameterValue.InvalidFilter | 无效过滤器。 |
| InvalidParameterValue.InvalidRegion | ecm region不合法。 |
| InvalidParameterValue.LimitExceeded | 参数值超出限制。 |
| InvalidParameterValue.Malformed | 入参格式不合法。 |
| InvalidParameterValue.Range | 参数值不在指定范围。 |
| ResourceNotFound | 资源不存在。 |
| UnauthorizedOperation.ForbiddenOperation | 没有权限进行该操作。 |
