describeSubnets

描述

查询子网列表

请求方式

GET

请求地址

https://yunding.jdcloud-api.com/v2/regions/{regionId}/ydSubnets/

名称	类型	是否必需	默认值	描述
regionId	String	True		Region ID

请求参数

名称	类型	是否必需	默认值	描述
pageNumber	Integer	False	1	页码, 默认为1, 取值范围：[1,∞), 页码超过总页数时, 显示最后一页
pageSize	Integer	False	20	分页大小，默认为20，取值范围：[10,100]
type	Integer	False		子网类型，主机等资源子网：1；LB子网：2；数据库子网：3
filters	Filter[]	False		subnetIds - subnet ID列表，支持多个 subnetNames - subnet名称列表，支持多个 routeTableId - 子网关联路由表Id，支持单个 aclId - 子网关联acl Id，支持单个 vpcId - 子网所属VPC Id，支持单个

Filter

名称	类型	是否必需	默认值	描述
name	String	True		过滤条件的名称
operator	String	False		过滤条件的操作符，默认eq
values	String[]	True		过滤条件的值

返回参数

名称	类型	描述
result	Result	返回结果
requestId	String	请求ID

Result

名称	类型	描述
subnets	Subnet[]	子网资源信息列表
totalCount	Number	总数量

Subnet

名称	类型	描述
subnetId	String	Subnet的Id
subnetName	String	子网名称
vpcId	String	子网所属VPC的Id
addressPrefix	String	子网网段，vpc内子网网段不能重叠，cidr的取值范围：10.0.0.0/8、172.16.0.0/12和192.168.0.0/16及它们包含的子网，且子网掩码长度为16-28之间，如果VPC含有Cidr，则必须为VPC所在Cidr的子网
availableIpCount	Number	子网网段内可用内网IP数，包含按单IP和按网段分配的内网IP
availableCidrIpCount	Number	预分配网段内可用IP数，在子网开启预分配网段功能后生效
ipMaskLen	Integer	子网内预留网段掩码长度，此网段IP地址按照单个申请，子网内其余部分IP地址以网段形式分配。此参数非必选，缺省值为0，代表子网内所有IP地址都按照单个申请(范围是[max{24, 子网掩码}, 28])
description	String	子网描述信息
routeTableId	String	子网关联的路由表Id
aclId	String	子网关联的acl Id
startIp	String	子网的起始地址，子网第1个地位为路由器网关保留，第2个地址为dhcp服务保留
endIp	String	子网的结束地址，子网第1个地位为路由器网关保留，第2个地址为dhcp服务保留
ipv6StartIp	String	子网的ipv6起始地址
ipv6EndIp	String	子网的ipv6结束地址
createdTime	String	子网创建时间
subnetType	String	子网类型，取值：standard(标准子网)，edge(边缘子网)
az	String	子网可用区
publicSubnet	Boolean	子网是否为外部子网（即子网路由表中存在下一跳为internet的路由或开启了eip优先访问）。true表示外部子网，false表示内部子网
tags	Tag[]	Tag信息
resourceGroupId	String	资源所属资源组ID
type	String	子网类型（hpc:智算,normal:普通）
hpcClusterId	String	子网所属hpc集群id

Tag

名称	类型	描述
key	String	Tag键
value	String	Tag值

返回码

HTTP状态码	错误码	描述
200		OK