查询子网列表

最近更新时间: 2026-09-17 00:07:24

1. 接口描述

接口请求域名： cloudhsm.api3.fincloud.tencent.cn。

查询子网列表

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

接口更新时间：2020-01-16 11:01:28。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeSubnet
Version 是 否 String 公共参数，本接口取值：2019-11-12
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Limit 是 否 Int64 返回数量。
示例值： 10
Offset 是 否 Int64 偏移量。
示例值： 0
VpcId 是 否 String 查询指定VpcId下的子网信息。
示例值： vpc-nc9yvu5p
SearchWord 否 否 String 查找关键字
示例值： subnet-4vxnrlco

3. 输出参数

参数名称 类型 描述
TotalCount Int64 返回的子网数量。
示例值： 1
SubnetList Array of Subnet 返回的子网实例列表。
示例值：查看
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
UnauthorizedOperation 未授权操作。
ResourceNotFound 资源不存在。

5. 示例

示例1 查询子网列表

查询子网列表

输入示例

https://kms.api3.fincloud.tencent.cn/?Action=DescribeSubnet
&Offset=0&Limit=10&VpcId=vpc-2at5y1pn
&<公共请求参数>

输出示例

{
  "Response": {
    "SubnetList": [
      {
        "VpcId": "vpc-2at5y1pn",
        "SubnetId": "subnet-otu92seu",
        "SubnetName": "默认二区子网",
        "CidrBlock": "172.16.16.0/24",
        "Ipv6CidrBlock": "3402:4e00:20:1201::/64",
        "AvailableIpAddressCount": 2,
        "CreatedTime": "2017-04-20 11:30:48"
      }
    ],
    "TotalCount": 1,
    "RequestId": "20569756-56ba-4a13-b545-e1528d5cb239"
  }
}