DescribeSubnets--私有网络-火山引擎

文档中心

立即注册

导航

DescribeSubnets

最近更新时间：2024.08.07 15:41:46首次发布时间：2021.07.29 14:11:53

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

调用说明

传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的子网，若没有符合条件的子网，则返回空值。
若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有子网。

调试

API Explorer

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

去调试

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	DescribeSubnets	要执行的操作。取值：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	否	SubnetIds.1=subnet-23dscddcffvf3**&SubnetIds.2=subnet-23dshjd0hsksd**	子网的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	否	TagFilters.1.Key=k1&TagFilters.2.Key=k2&TagFilters.3.Key=k3	标签的标签键。参数 - N：表示标签键的序号，取值范围：1～10。多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的子网。不允许重复。
TagFilters.N.Values.N	String	否	TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.3.Values.1=v1	标签的标签值。第一个N：表示标签键的序号，取值范围：1～10。第二个N：表示标签值的序号，取值范围：1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的子网。多个标签值之间用&分隔。说明若传入该参数，则必须先传入`TagFilters.N.Key`。传入空字符串时，表示查询标签值为空的子网。
IsDefault	Boolean	否	false	该子网是否为默认子网。 true：默认子网，表示该子网是创建ECS实例时系统自动创建的子网。 false：非默认子网，表示该子网是用户手动创建的。
SubnetOwnerId	String	否	2000****	子网所属的主账号ID。
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	Array of Struct	-	子网的详细信息。详细信息请参见下表“ Subnets结构 ”。

Subnets结构

参数名称	类型	示例值	描述
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	Struct	-	路由表信息。详细信息请参见下表“ RouteTable结构 ”。
ProjectName	String	default	子网所属项目的名称。
Tags	Array of Struct	-	子网的标签信息。具体请参见下表“Tag结构”。

RouteTable结构

参数名称	类型	示例值	描述
RouteTableId	String	vrt-bp145q7glnuzdv****	子网关联的路由表ID。
RouteTableType	String	System	子网关联的路由表的类型。 System：表示系统路由表。 Custom：表示自定义路由表。

参数名称

类型

示例值

描述

RouteTableId

String

vrt-bp145q7glnuzdv****

子网关联的路由表ID。

RouteTableType

String

System

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

System：表示系统路由表。
Custom：表示自定义路由表。

Tag结构

参数名称	类型	示例值	描述
Key	String	k1	标签的标签键。
Value	String	v1	标签的标签值。

请求示例

GET /?Action=DescribeSubnets&Version=2020-04-01&VpcId=vpc-bp1b1xjllp3ve5yze****&ZoneId=cn-beijing-a HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "DescribeSubnets",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-beijing"
    },
   "Result": {
        "RequestId": "2021062415303301022514515207C4****",
        "TotalCount": 2,
        "PageNumber": 1,
        "PageSize": 20,
        "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
        "Subnets": [
           {
              "AccountId":  "2000000959",
              "AvailableIpAddressCount": 1,
              "CidrBlock": "172.XX.XX.0/24",
              "CreationTime": "2018-01-18T12:43:57+08:00",
              "UpdateTime":  "2018-01-18T13:43:57+08:00",
              "ProjectName": "default",
              "Tags": [
                    {
                        "Key":"k1",
                        "Value":"v1"
                    },
                    {
                        "Key":"k2",
                        "Value":""
                    }
                ]，
              "Description": "description",
              "IsDefault": false,
              "RouteTable": {
                    "RouteTableId": "vrt-bp145q7glnuzdv****",
                    "RouteTableType": "System"
                },
              "Status": "Available",
              "SubnetId": "subnet-1323sadadda***",
              "TotalIpv4Count": 253,
              "SubnetName": "subnet-1",
              "VpcId": "vpc-bp1b1xjllp3ve5yze****",
              "NetworkAclId": "acl-bp1fg655nh68xyz9****",
              "ZoneId": "cn-beijing-a"
            }
          ],
        "TotalCount": 2
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode	错误码	错误信息	描述
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.	已达到单次可指定过滤标签值数量的上限。
404	InvalidZoneId.NotFound	The specified zone does not exist.	指定的可用区不存在。