操作指南

API文档

诚邀爱技术、爱分享的你,成为文档内容共建者> HOT

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。
Filters.N Array of Filter 过滤条件,参数不支持同时指定SubnetIds和Filters。
  • subnet-id - String - (过滤条件)Subnet实例名称。
  • vpc-id - String - (过滤条件)VPC实例ID,形如:vpc-f49l6u0z。
  • cidr-block - String - (过滤条件)子网网段,形如: 192.168.1.0 。
  • is-default - Boolean - (过滤条件)是否是默认子网。
  • is-remote-vpc-snat - Boolean - (过滤条件)是否为VPC SNAT地址池子网。
  • subnet-name - String - (过滤条件)子网名称。
  • zone - String - (过滤条件)可用区。
  • tag-key - String -是否必填:否- (过滤条件)按照标签键进行过滤。
  • tag:tag-key - String - 是否必填:否 - (过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。使用请参考示例2。
  • cdc-id - String - 是否必填:否 - (过滤条件)按照cdc信息进行过滤。过滤出来制定cdc下的子网。
  • is-cdc-subnet - String - 是否必填:否 - (过滤条件)按照是否是cdc子网进行过滤。取值:“0”-非cdc子网,“1”--cdc子网
  • Offset String 偏移量,默认为0。
    Limit String 返回数量,默认为20,最大值为100。

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的实例数量。
    SubnetSet Array of Subnet 子网对象。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询子网列表

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeSubnets
    &Filters.0.Name=subnet-name
    &Filters.0.Values.0=默认广州二区子网
    &Filters.1.Name=vpc-id
    &Filters.1.Values.0=vpc-2at5y1pn
    &Filters.2.Name=subnet-id
    &Filters.2.Values.0=subnet-otu92seu
    &Filters.3.Name=cidr-block
    &Filters.3.Values.0=172.16.16.0
    &Filters.4.Name=is-default
    &Filters.4.Values.0=true
    &<公共请求参数>

    输出示例

    {
        "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 查询绑定了标签的子网列表

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeSubnets
    &Filters.0.Name=tag:city
    &Filters.0.Values.0=shanghai
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "SubnetSet": [
                {
                    "NetworkAclId": "",
                    "RouteTableId": "rtb-n0yr460a",
                    "VpcId": "vpc-n0yr460a",
                    "EnableBroadcast": false,
                    "Zone": "ap-guangzhou",
                    "Ipv6CidrBlock": "xx",
                    "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。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    InternalError.ModuleError 内部模块错误。
    InvalidParameter.Coexist 参数不支持同时指定。
    InvalidParameter.FilterInvalidKey 指定过滤条件不存在。
    InvalidParameter.FilterNotDict 指定过滤条件不是键值对。
    InvalidParameter.FilterValuesNotList 指定过滤选项值不是列表。
    InvalidParameterValue.Empty 缺少参数。
    InvalidParameterValue.LimitExceeded 参数值超出限制。
    InvalidParameterValue.Malformed 入参格式不合法。
    InvalidParameterValue.Range 参数值不在指定范围。
    ResourceNotFound 资源不存在。
    UnsupportedOperation 操作不支持。
    UnsupportedOperation.AppIdMismatch 资源不在指定的AppId下。
    目录