查询子网列表

最近更新时间:2019-07-24 15:03:04

1. 接口描述

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

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

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

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeSubnets
Version String 公共参数,本接口取值:2018-06-25
Region String 公共参数,本接口不需要传递此参数。
SubnetIds.N Array of String 子网实例ID查询。形如:subnet-pxir56ns。参数不支持同时指定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。
subnet-name - String - (过滤条件)子网名称。
zone - String - (过滤条件)可用区。
Offset Integer 偏移量
Limit Integer 返回数量

3. 输出参数

参数名称 类型 描述
SubnetSet Array of SubnetInfo 子网列表信息
TotalCount Integer 返回的子网总数
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询子网列表

输入示例

https://bmvpc.tencentcloudapi.com/?Action=DescribeSubnets
&SubnetIds.0=subnet-jzc4ky5d
&<公共请求参数>

输出示例

{
  "Response": {
    "SubnetSet": [
      {
        "VpcId": "vpc-7x7kx4s4",
        "VpcName": "BMGZHW-206000",
        "VpcCidrBlock": "10.88.0.0/16",
        "SubnetId": "subnet-jzc4ky5d",
        "SubnetName": "ianhu",
        "CidrBlock": "10.88.0.0/24",
        "Type": 0,
        "ZoneId": 1000100002,
        "CpmNum": 0,
        "VlanId": 5,
        "DistributedFlag": 1,
        "DhcpEnable": 0,
        "DhcpServerIp": [],
        "IpReserve": 0,
        "AvailableIpNum": 0,
        "TotalIpNum": 0,
        "SubnetCreateTime": "2018-12-03 14:39:16",
        "IsSmartNic": 0
      }
    ],
    "TotalCount": 1,
    "RequestId": "b01f7baa-d5f5-4b97-9704-e3b98dc6687a"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败
InternalError 内部错误
InvalidParameter 参数错误