查询子网列表

最近更新时间:2018-10-26 15:01:13

1. 接口描述

接口请求域名: vpc.tencentcloudapi.com 。

本接口(DescribeSubnets)用于查询子网列表。

默认接口请求频率限制:100次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:vpc.ap-shanghai-fsi.tencentcloudapi.com 。

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 - (过滤条件)vpc的cidr。
  • is-default - Boolean - (过滤条件)是否是默认子网。
  • subnet-name - String - (过滤条件)子网名称。
  • zone - String - (过滤条件)可用区。
  • Offset String 偏移量
    Limit String 返回数量

    3. 输出参数

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

    4. 示例

    示例1 查询子网列表

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeSubnets
    &Version=2017-03-12
    &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": {
        "RequestId": "20569756-56ba-4a13-b545-e1528d5cb239",
        "SubnetSet": [
          {
            "AvailableIpAddressCount": 4002,
            "CidrBlock": "172.16.16.0/20",
            "CreatedTime": "2017-04-20 11:30:48",
            "EnableBroadcast": false,
            "IsDefault": true,
            "RouteTableId": "rtb-l2h8d7c2",
            "SubnetId": "subnet-otu92seu",
            "SubnetName": "默认广州二区子网",
            "VpcId": "vpc-2at5y1pn",
            "Zone": "ap-guangzhou-dev-2"
          }
        ],
        "TotalCount": 1
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidParameter.Coexist 参数不支持同时指定。
    InvalidParameterValue.Malformed 入参格式不合法。
    ResourceNotFound 资源不存在。