帮你快速理解、总结文档立即下载
文档中心>API 中心

查询子网列表

最近更新时间：2025-09-12 01:15:47
我的收藏

本页目录：

1. 接口描述

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

本接口（DescribeSubnets）用于查询黑石子网列表。

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

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 返回数量
OrderField 否 String 排序字段, 支持按“CreateTime”，“VlanId”
OrderDirection 否 String 排序方向, “asc”、“desc”

3. 输出参数

参数名称 类型 描述
SubnetSet Array of SubnetInfo 子网列表信息
TotalCount Integer 返回的子网总数
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询子网列表

输入示例

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

输出示例

{
    "Response": {
        "SubnetSet": [
            {
                "VpcId": "vpc-ajhuxpbc",
                "VpcName": "test_vpc33333333",
                "VpcCidrBlock": "10.27.0.0/16",
                "SubnetId": "subnet-d6tl3i45",
                "SubnetName": "test_sub2",
                "CidrBlock": "10.27.2.0/24",
                "Type": 0,
                "ZoneId": 1000100002,
                "Zone": "ap-guangzhoutest-blshw-1",
                "VpcZoneId": 1000100002,
                "VpcZone": "ap-guangzhoutest-blshw-1",
                "CpmNum": 1,
                "VlanId": 5,
                "DistributedFlag": 1,
                "DhcpEnable": 0,
                "DhcpServerIp": [],
                "IpReserve": 0,
                "AvailableIpNum": 249,
                "TotalIpNum": 253,
                "SubnetCreateTime": "2017-01-12 16:17:07",
                "IsSmartNic": 0,
                "BroadcastFlag": 0
            }
        ],
        "TotalCount": 69,
        "RequestId": "d6f18c72-704e-4205-8bf4-9b7bbc5257bd"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

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