调用 DescribeSubnets 接口，查询满足指定条件的子网。

使用说明

传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的子网，若没有符合条件的子网，则返回空值。

若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有子网。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action String 必选示例值：DescribeSubnets

接口名称。当前 API 的名称为DescribeSubnets。

Version String 必选示例值：2020-04-01

接口版本。当前 API 的版本为 2020-04-01。

ZoneId String 可选示例值：cn-beijing-a

子网所属可用区的ID。

VpcId String 可选示例值：vpc-bp1b1xjllp3ve5yze****

子网所属VPC的ID。

您可以调用 DescribeVpcs 接口，查询VPC的ID。

SubnetIds.N String 可选示例值：subnet-23

子网的ID。

参数 - N：表示子网ID的序号，单次调用数量上限为100个。

多个ID之间用&分隔。

SubnetName String 可选示例值：subnet-1323sadadda****

子网的名称。

SubnetOwnerId String 可选示例值：2000****

子网所属的主账号ID。

RouteTableId String 可选示例值：vrt-bp145q7glnuzdv****

子网关联路由表的ID。

ProjectName String 可选示例值：default

子网所在VPC实例所属项目的名称。

TagFilters.N.Key String 可选示例值：k1

标签的标签键。

参数 - N：表示标签键的序号，取值范围：1～10。

多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的子网。

不允许重复。

TagFilters.N.Values.N String 可选示例值：v1

标签的标签值。

第一个N：表示标签键的序号，取值范围：1～10。

第二个N：表示标签值的序号，取值范围：1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的子网。

多个标签值之间用&分隔。

说明

若传入该参数，则必须先传入TagFilters.N.Key。

传入空字符串时，表示查询标签值为空的子网。

IsDefault Boolean 可选示例值：false

该子网是否为默认子网。请严格按照以下枚举值的大小写输入，不要传入其他取值。

true：默认子网，表示该子网是创建ECS实例时系统自动创建的子网。

false：非默认子网，表示该子网是用户手动创建的。

PageNumber Integer 可选示例值：1

列表的页码。默认值为1。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

PageSize Integer 可选示例值：20

分页查询时每页的行数。最大值为100，默认值为20。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

NextToken String 可选示例值：caeba0bbb2be03f84eb48b699f0a****

分页查询凭证，用于标记分页的位置。

不填则从头开始查询。

传入之前调用本API返回的NextToken，则从该次API调用标记分页的位置往后开始查询。

MaxResults Integer 可选示例值：50

查询的数量，默认为 10，最大为100。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

RequestId String 示例值：2021062415303301022514515207C4****

请求ID。

TotalCount Integer 示例值：2

符合条件的子网总数。

说明

本参数即将下线，使用NextToken和MaxResults分页查询时，此参数无意义。

PageNumber Integer 示例值：1

当前页码。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

PageSize Integer 示例值：10

当前分页的行数。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

NextToken String 示例值：caeba0bbb2be03f84eb48b699f0a****

本次API调用返回的查询凭证，标记分页的位置，用于下一次查询。返回为空表示没有下一页。

Subnets Object[] 示例值：-

子网的详细信息。

AccountId String 示例值：200000****

子网所属账户的ID。

SubnetId String 示例值：subnet-25bcdxs7pv1****

子网的ID。

VpcId String 示例值：vpc-257gcdcdq64****

子网所属VPC的ID。

Status String 示例值：Available

子网的状态。

Pending：表示配置中。

Available：表示可用。

CidrBlock String 示例值：172.XX.XX.0/24

子网的IPv4网段。

Ipv6CidrBlock String 示例值：2408:XXXX:0:a600::/64

子网的IPv6网段。

说明

IPv6功能正在邀测中，如需试用，请联系客户经理。

ZoneId String 示例值：cn-beijing-a

子网所属的可用区。

AvailableIpAddressCount Integer 示例值：1

子网中可用的IP地址数量。

Description String 示例值：Description

子网的描述信息。

SubnetName String 示例值：subnet-1

子网的名称。

CreationTime String 示例值：2018-01-18T12:43:57+08:00

子网的创建时间。

UpdateTime String 示例值：2019-01-18T11:23:55+08:00

子网的更新的时间。

TotalIpv4Count Integer 示例值：253

子网下可用IP总数。

NetworkAclId String 示例值：acl-bp1fg655nh68xyz9****

子网关联的网络ACL的ID。

IsDefault Boolean 示例值：false

该子网是否为默认子网。

true：默认子网，表示该子网是创建ECS实例时系统自动创建的子网。

false：非默认子网，表示该子网是用户手动创建的。

RouteTable Object 示例值：--

路由表信息。

RouteTableId String 示例值：vrt-bp145q7glnuzdv****

子网关联的路由表ID。

RouteTableType String 示例值：System

子网关联的路由表的类型。

System：表示系统路由表。

Custom：表示自定义路由表。

ProjectName String 示例值：default

子网所属项目的名称。

Tags Object[] 示例值：--

子网的标签信息。

Key String 示例值：k1

标签的标签键。

Value String 示例值：v1

标签的标签值。

请求示例

返回示例

错误码

状态码	错误码	错误信息	说明
400	DryRunOperation	Exception raised to indicate a successfully authorized action when the DryRun flag is set to true.	该请求设置为DryRun操作，操作授权已获得许可，但未被实际执行。
400	InvalidMaxResults.Malformed	The specified parameter MaxResults is malformed.	查询数量不合法。
400	InvalidNextToken.Malformed	The specified parameter NextToken is invalid.	查询 NextToken 不合法。
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。
400	InvalidTagFilter.Disorder	The specified index order of tag filter is malformed.	指定标签过滤项的索引顺序参数格式不合法。
400	InvalidTagFilterKey.Malformed	The specified parameter tag filter key is invalid.	过滤标签键不合法。
400	InvalidTagFilterValue.Malformed	The specified parameter tag filter value is invalid.	过滤标签值不合法。
400	LimitExceeded.SubnetId	You've reached the limit on the number of subnet IDs that you can describe.	已达到可查询的子网ID数量上限。
400	LimitExceeded.TagFilterKey	You've reached the limit on the number of tag keys that you can filter.	已达到单次可指定过滤标签键数量的上限。
400	LimitExceeded.TagFilterValue	You've reached the limit on the number of tag values that you can filter.	已达到单次可指定过滤标签值数量的上限。

私有网络