调用 DescribeVpcs 接口，查询满足指定条件的VPC。 ## 使用说明 * 传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的VPC，若没有符合条件的VPC，则返回空值。 * 若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有VPC。 * 使用标签过滤VPC实例时，最多可查询指定标签关联的1000个VPC实例。如果指定标签关联的VPC实例超过1000个，则只返回前1000个。此时请使用[ListTagsForResources](https://www.volcengine.com/docs/6401/129394)接口查询。 ## 调试 ## 请求参数下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见[公共参数](https://www.volcengine.com/docs/6369/67268)。 **Action** String %%require%% `示例值：DescribeVpcs` 接口名称。当前 API 的名称为`DescribeVpcs`。 **Version** String %%require%% `示例值：2020-04-01` 接口版本。当前 API 的版本为 `2020-04-01`。 **VpcIds.N** String `可选` `示例值：vpc-bp1b1p3ve5yze****` VPC的ID。 * 参数 \- N：表示VPC ID的序号，单次调用数量上限为100个。 * 多个VPC ID之间用&分隔。 **VpcName** String `可选` `示例值：Vpc-1` VPC的名称。 **ProjectName** String `可选` `示例值：default` VPC所属项目的名称。 **TagFilters.N.Key** String `可选` `示例值：k1` 标签的标签键。 * 参数 \- N：表示标签键的序号，取值范围：1～10。 * 多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的VPC。 * 不允许重复。 **TagFilters.N.Values.N** String `可选` `示例值：v1` 标签的标签值。 * 第一个N：表示标签键的序号，取值范围：1～10。 * 第二个N：表示标签值的序号，取值范围：1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的VPC。 * 多个标签值之间用&分隔。 :::tip * 若传入该参数，则必须先传入`TagFilters.N.Key`。 * 传入空字符串时，表示查询标签值为空的VPC。 ::: **IsDefault** Boolean `可选` `示例值：false` 该VPC是否为默认VPC。请严格按照以下枚举值的大小写输入，不要传入其他取值。 * true：默认VPC，表示该VPC是创建ECS实例时系统自动创建的VPC。 * false：非默认VPC，表示该VPC是用户手动创建的。 **VpcOwnerId** String `可选` `示例值：210367****` 私有网络所属主账号的ID。 **PageNumber** Integer `可选` `示例值：1` 列表的页码。默认值为1。 :::tip 本参数即将下线，建议您使用`NextToken`和`MaxResults`进行分页查询。 ::: **PageSize** Integer `可选` `示例值：20` 分页查询时每页的行数。最大值为100，默认值为20。 :::tip 本参数即将下线，建议您使用`NextToken`和`MaxResults`进行分页查询。 ::: **NextToken** String `可选` `示例值：caeba0bbb2be03f84eb48b699f0a****` 分页查询凭证，用于标记分页的位置。 * 不填则从头开始查询。 * 传入之前调用本API返回的`NextToken`，则从该次API调用标记分页的位置往后开始查询。 **MaxResults** Integer `可选` `示例值：50` 查询的数量，默认为 10，最大为100。 ## 返回参数下方仅列出本接口特有的返回参数。更多信息请参见[返回结构](https://www.volcengine.com/docs/6369/80336)。 **RequestId** String `示例值：2021062415303301022514515207C4****` 请求ID。 **TotalCount** Integer `示例值：2` 符合条件的VPC总数。 :::tip 本参数即将下线，使用`NextToken`和`MaxResults`分页查询时，此参数无意义。 ::: **PageNumber** Integer `示例值：1` 当前页码。 :::tip 本参数即将下线，建议您使用`NextToken`和`MaxResults`进行分页查询。 ::: **PageSize** Integer `示例值：10` 当前分页的行数。 :::tip 本参数即将下线，建议您使用`NextToken`和`MaxResults`进行分页查询。 ::: **NextToken** String `示例值：caeba0bbb2be03f84eb48b699f0a****` 本次API调用返回的查询凭证，标记分页的位置，用于下一次查询。返回为空表示没有下一页。 **Vpcs** Object[] `示例值：-` VPC的详细信息。 **AccountId** String `示例值：21000****` VPC所属账号的ID。 **VpcId** String `示例值：vpc-bp1qpo0kug3a20qqe****` VPC的ID。 **VpcName** String `示例值：vpc1` VPC的名称。 **Description** String `示例值：This is my VPC.` VPC的描述信息。 **CidrBlock** String `示例值：10.XX.XX.0/8` VPC的IPv4网段。 **Ipv6CidrBlock** String `示例值：2408:XXXX:0:a600::/56` VPC的IPv6网段。 :::tip IPv6功能正在邀测中，如需试用，请联系客户经理。 ::: **Ipv6CidrBlocks** Object[] `示例值：-` VPC的IPv6网段的信息。 **Ipv6CidrBlock** String `示例值：2408:XXXX:0:a600::/56` VPC的IPv6网段。 **Ipv6Isp** String `示例值：ChinaMobile` 线路类型。 * BGP：BGP（多线）。 * ChinaMobile：中国移动静态单线。 * ChinaTelecom：中国电信静态单线。 * ChinaUnicom：中国联通静态单线。 * ChinaMobile_Value：中国移动惠选型静态单线。 * ChinaUnicom_Value：中国联通惠选型静态单线。 * ChinaTelecom_Value：中国电信惠选型静态单线。 :::tip 除BGP（多线）外，其余线路类型均仅支持华东2（上海）地域。 ::: **SecondaryCidrBlocks** String[] `示例值：["10.XX.XX.0/16"]` VPC的辅助网段。 **UserCidrBlocks** String[] `示例值：["72.XX.XX.0/24"]` VPC的用户网段。 :::tip VPC的用户网段正在邀测中，如需试用，请联系客户经理 ::: **SubnetIds** String[] `示例值：["subnet-2fe74yvngdukg5oxruwgq****"]` VPC中子网的列表。 **RouteTableIds** String[] `示例值：["vtb-bp1krxxzp0c29fmon****"]` VPC关联的路由表ID。 **NetworkAclNum** String `示例值：5` VPC中的网络ACL的数量。 **SecurityGroupIds** String[] `示例值：["securitygroup178ftwt45bg****"]` VPC中安全组的列表。 **NatGatewayIds** String[] `示例值：["ngw-3tjx9odz8q3vj0x1****"]` VPC中创建的NAT网关的ID。 :::tip 若VPC下没有创建NAT网关，将不会返回此参数。 ::: **AssociateCens** Object[] `示例值：-` VPC关联的CEN信息。 **CenId** String `示例值：cen-23887d****` CEN的ID。 **CenOwnerId** String `示例值：12223****` CEN的用户ID。 **CenStatus** String `示例值：Attached` VPC在CEN中的状态。 * Attaching：加载中 * Attached：已加载 **IsDefault** Boolean `示例值：false` 该VPC是否为默认VPC。 * true：默认VPC，表示该VPC是创建ECS实例时系统自动创建的VPC。 * false：非默认VPC，表示该VPC是用户手动创建的。 **DnsServers** String[] `示例值：["100.96.0.2"]` DNS服务器。 **Status** String `示例值：Available` VPC的状态。 * Creating: 创建中 * Pending：配置中 * Available：可用 **ProjectName** String `示例值：default` VPC所属项目的名称。 **Tags** Object[] `示例值：-` VPC的标签信息。 **Key** String `示例值：k1` 标签的标签键。 **Value** String `示例值：v1` 标签的标签值。 **CreationTime** String `示例值：2018-04-18T15:02:37+08:00` 创建VPC的时间。 **UpdateTime** String `示例值：2019-04-25T01:37:38+08:00` 更新VPC的时间。 ## 请求示例 ```json GET /?Action=DescribeVpcs&Version=2020-04-01&NextToken=caeba0bbb2be03f84eb48b699f0a****&MaxResults=50 HTTP/1.1 Host: vpc.cn-beijing.volcengineapi.com X-Data: 20250804T033538Z Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250804/cn-beijing/vpc/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f ``` ## 返回示例 ```json { "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "DescribeVpcs", "Version": "2020-04-01", "Service": "vpc", "Region": "cn-beijing" }, "Result": { "NextToken": "caeba0bbb2be03f84eb48b699f0a****", "PageNumber": 1, "PageSize": 10, "RequestId": "2021062415303301022514515207C4****", "TotalCount": 2, "Vpcs": [ { "Tags": [ { "Key": "k1", "Value": "v1" } ], "VpcId": "vpc-bp1qpo0kug3a20qqe****", "Status": "Available", "VpcName": "vpc1", "AccountId": "21000****", "CidrBlock": "10.XX.XX.0/8", "IsDefault": true, "SubnetIds": [ "subnet-2fe74yvngdukg5oxruwgq****" ], "DnsServers": [ "100.96.0.2" ], "UpdateTime": "2019-04-25T01:37:38+08:00", "Description": "This is my VPC.", "ProjectName": "default", "CreationTime": "2018-04-18T15:02:37+08:00", "AssociateCens": [ { "CenId": "cen-23887d****", "CenStatus": "Attached", "CenOwnerId": "12223****" } ], "Ipv6CidrBlock": "2408:XXXX:0:a600::/56", "NatGatewayIds": [ "ngw-3tjx9odz8q3vj0x1****" ], "NetworkAclNum": "5", "RouteTableIds": [ "vtb-bp1krxxzp0c29fmon****" ], "Ipv6CidrBlocks": [ { "Ipv6Isp": "ChinaMobile", "Ipv6CidrBlock": "2408:XXXX:0:a600::/56" } ], "UserCidrBlocks": [ "72.XX.XX.0/24" ], "SecurityGroupIds": [ "securitygroup178ftwt45bg****" ], "SecondaryCidrBlocks": [ "10.XX.XX.0/16" ] } ] } } ``` ## 错误码 |状态码 |错误码 |错误信息 |说明 | |---|---|---|---| |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.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. |已达到单次可指定过滤标签值数量的上限。 | |400 |LimitExceeded.VpcId |You've reached the limit on the number of VPC IDs that you can describe. |已达到可查询的VPC ID数量上限。 |

容器服务