DescribeVpcs - 查询已创建的VPC - 专有网络 VPC

查询已创建的VPC。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
vpc:DescribeVpcs	list	VPC `acs:vpc:{#regionId}:{#accountId}:vpc/` *VPC `acs:vpc:{#regionId}:{#accountId}:vpc/{#VPCId}`	vpc:tag	无

请求参数

名称	类型	必填	描述	示例值
VpcId	string	否	VPC 的 ID。最多支持指定 20 个 VPC ID，多个 VPC 的 ID 之间用半角逗号（,）隔开。	vpc-bp1b1xjllp3ve5yze****
RegionId	string	是	VPC 所在的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou
VpcName	string	否	VPC 的名称。	Vpc-1
IsDefault	boolean	否	是否查询指定地域下的默认 VPC，取值： true（默认值）：查询指定地域下的默认 VPC。 false：不查询默认 VPC。	false
DryRun	boolean	否	是否只预检此次请求，取值： true：发送检查请求，不会查询资源状况。检查项包括 AccessKey 是否有效、RAM 用户的授权情况和是否填写了必需参数。如果检查不通过，则返回对应错误。如果检查通过，会返回错误码`DryRunOperation`。 false（默认值）：发送正常请求，通过检查后返回 HTTP 2xx 状态码并直接查询资源状况。	false
ResourceGroupId	string	否	要查询的 VPC 所属的资源组 ID。	rg-acfmxvfvazb4p****
PageNumber	integer	否	列表的页码，默认值为 1。	1
PageSize	integer	否	分页查询时每页的行数，最大值为 50，默认值为 10。	10
VpcOwnerId	long	否	VPC 所属的阿里云账号 ID。	253460731706911258
DhcpOptionsSetId	string	否	DHCP 选项集的 ID。	dopt-o6w0df4epg9zo8isy****
EnableIpv6	boolean	否	是否查询指定地域下开启 IPv6 网段的 VPC，默认为空值（空值则不根据是否开启 IPv6 网段做过滤），取值： false：不开启。 true：开启。	false
Tag	array<object>	否	资源的标签。
	object	否	标签。
Key	string	否	资源的标签键。最多支持输入 20 个标签键。如需传入该值，则不能输入空字符串。一个标签键最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceDept
Value	string	否	资源的标签值。最多支持输入 20 个标签值。如需传入该值，可以输入空字符串。最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceJoshua

返回参数

名称	类型	描述	示例值
	object	返回的信息。
PageSize	integer	分页查询时每页的行数。	10
RequestId	string	请求 ID。	C6532AA8-D0F7-497F-A8EE-094126D441F5
PageNumber	integer	列表的页码。	1
TotalCount	integer	列表条目数。	2
Vpcs	array<object>	VPC 的详细信息。
Vpc	object	VPC 的详细信息。
CreationTime	string	VPC 的创建时间。	2021-04-18T15:02:37Z
Status	string	VPC 的状态，取值： Pending：配置中。 Available：可用。	Available
VpcId	string	VPC 的 ID。	vpc-bp1qpo0kug3a20qqe****
IsDefault	boolean	是否是该地域的默认 VPC。取值： true：是该地域的默认 VPC。 false：不是该地域的默认 VPC。	false
OwnerId	long	VPC 所属的阿里云账号 ID。	253460731706911258
RegionId	string	VPC 所在的地域 ID。	cn-hangzhou
VpcName	string	VPC 的名称。	vpc1
VRouterId	string	VPC 路由器的 ID。	vrt-bp1jcg5cmxjbl9xgc****
DhcpOptionsSetStatus	string	DHCP 选项集的状态。取值： Available：可用。 InUse：使用中。 Deleted：已删除。 Pending：配置中。	Available
CidrBlock	string	VPC 的 IPv4 网段。	192.168.0.0/16
Description	string	VPC 的描述信息。	This is my VPC.
ResourceGroupId	string	VPC 所属的资源组 ID。	rg-acfmxazb4ph****
DhcpOptionsSetId	string	DHCP 选项集的 ID。	dopt-o6w0df4epg9zo8isy****
Ipv6CidrBlock	string	VPC 的 IPv6 网段。	2408:XXXX:0:a600::/56
CenStatus	string	VPC 绑定云企业网的状态。仅 VPC 绑定了云企业网时返回 Attached。	Attached
Tags	array<object>	VPC 的标签信息。
Tag	object	VPC 的标签信息。
Key	string	VPC 绑定的标签键。	FinanceDept
Value	string	VPC 绑定的标签值。	FinanceJoshua
Ipv6CidrBlocks	array<object>	VPC 的 IPv6 网段信息。
Ipv6CidrBlock	object	VPC 的 IPv6 网段信息。
Ipv6Isp	string	VPC 的 IPv6 地址段类型，取值： BGP：阿里云 BGP IPv6。 ChinaMobile：中国移动（单线）。 ChinaUnicom：中国联通（单线）。 ChinaTelecom：中国电信（单线）。说明如果是开通了单线带宽白名单的用户，该字段可以设置为 ChinaTelecom（中国电信）、ChinaUnicom（中国联通）和 ChinaMobile（中国移动）。	BGP
Ipv6CidrBlock	string	VPC 的 IPv6 网段。	2408:XXXX:0:a600::/56
VSwitchIds	array	查询到的 VPC 中交换机的列表信息。最多可以查询到 VPC 中最近创建的 300 个交换机的信息。如果您需要查询 VPC 中全部交换机的信息，可以执行 DescribeVSwitches 接口查询。
VSwitchId	string	查询到的 VPC 中交换机的列表信息。最多可以查询到 VPC 中最近创建的 300 个交换机的信息。如果您需要查询 VPC 中全部交换机的信息，可以执行 DescribeVSwitches 接口查询。	vsw-bp1nhbnpv2blyz8dl****
SecondaryCidrBlocks	array	附加网段信息。
SecondaryCidrBlock	string	VPC 的附加网段。	192.168.20.0/24
UserCidrs	array	用户侧网段的列表。
UserCidr	string	用户侧网段的列表。	10.0.0.0/8
NatGatewayIds	array	NAT 网关的 ID。
NatGatewayIds	string	NAT 网关的 ID。	nat-245xxxftwt45bg****
RouterTableIds	array	路由表信息。
RouterTableIds	string	路由表 ID。	vtb-bp1krxxzp0c29fmon****
EnabledIpv6	boolean	是否开启 IPv6。枚举值： false：false。 true：true。	false
DnsHostnameStatus	string	是否开启 DNS 主机名。	DISABLED

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "C6532AA8-D0F7-497F-A8EE-094126D441F5",
  "PageNumber": 1,
  "TotalCount": 2,
  "Vpcs": {
    "Vpc": [
      {
        "CreationTime": "2021-04-18T15:02:37Z",
        "Status": "Available",
        "VpcId": "vpc-bp1qpo0kug3a20qqe****",
        "IsDefault": false,
        "OwnerId": 253460731706911260,
        "RegionId": "cn-hangzhou",
        "VpcName": "vpc1",
        "VRouterId": "vrt-bp1jcg5cmxjbl9xgc****",
        "DhcpOptionsSetStatus": "Available",
        "CidrBlock": "192.168.0.0/16",
        "Description": "This is my VPC.",
        "ResourceGroupId": "rg-acfmxazb4ph****",
        "DhcpOptionsSetId": "dopt-o6w0df4epg9zo8isy****",
        "Ipv6CidrBlock": "2408:XXXX:0:a600::/56",
        "CenStatus": "Attached",
        "Tags": {
          "Tag": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        },
        "Ipv6CidrBlocks": {
          "Ipv6CidrBlock": [
            {
              "Ipv6Isp": "BGP",
              "Ipv6CidrBlock": "2408:XXXX:0:a600::/56"
            }
          ]
        },
        "VSwitchIds": {
          "VSwitchId": [
            "vsw-bp1nhbnpv2blyz8dl****"
          ]
        },
        "SecondaryCidrBlocks": {
          "SecondaryCidrBlock": [
            "192.168.20.0/24"
          ]
        },
        "UserCidrs": {
          "UserCidr": [
            "10.0.0.0/8"
          ]
        },
        "NatGatewayIds": {
          "NatGatewayIds": [
            "nat-245xxxftwt45bg****"
          ]
        },
        "RouterTableIds": {
          "RouterTableIds": [
            "vtb-bp1krxxzp0c29fmon****"
          ]
        },
        "EnabledIpv6": false,
        "DnsHostnameStatus": "DISABLED"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidVpcIdNumber.NotSupported	The number of vpcIds exceeds the limit.	vpcId数量超出限制
400	InvalidAliuid	User Id is not valid.	-
400	InvalidResourceGroupId	The specified ResourceGroupId does not exist.	资源组ID不存在。
400	InvalidTagKey	The tag keys are not valid.	无效的标签索引
400	InvalidTagValue	The tag values are not valid.	无效的标签值
400	InvalidResourceGroupId.NotFound	The Specified ResourceGroupId not exists.	-
400	OperationUnsupported.ResourceGroupId	%s	-
400	IellgalParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.	指定参数 OwnerAccount 不合法
400	IllegalParam.OwnerId	The specified parameter VpcOwnerId is not valid.	-
400	InvalidAccount.NotFound	The account is invalid.	操作失败，使用了无效的调用账号。
500	InternalError	The request processing has failed due to some unknown error.	请求处理由于某些未知错误失败。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-10-10	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-08-27	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-05-16	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2024-04-09	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-07-26	OpenAPI 错误码发生变更	查看变更详情
2023-07-26	OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2023-06-13	OpenAPI 错误码发生变更	查看变更详情