调用DescribeVpcs接口查询已创建的VPC。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeVpcs

要执行的操作。取值:DescribeVpcs

RegionId String cn-hangzhou

VPC所在的地域。

您可以通过调用DescribeRegions接口获取地域ID。

VpcId String vpc-bp1b1xjllp3ve5yze****

VPC的ID。

最多支持指定20个VPC ID,多个VPC ID之间用半角逗号隔开。

VpcName String Vpc-1

VPC的名称。

IsDefault Boolean false

是否查询指定地域下的默认VPC,取值:

  • true(默认值):查询指定地域下的所有VPC。
  • false:不查询默认VPC。
DryRun Boolean false

是否只预检此次请求,取值:

  • true:发送检查请求,不会查询资源状况。检查项包括AccessKey是否有效、RAM用户的授权情况和是否填写了必需参数。如果检查不通过,则返回对应错误。如果检查通过,会返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回2XX HTTP状态码并直接查询资源状况。
ResourceGroupId String rg-acfmxvfvazb4p****

要查询的VPC所属的资源组ID。

PageNumber Integer 1

列表的页码,默认值为1

PageSize Integer 10

分页查询时每页的行数,最大值为50,默认值为10

返回数据

名称 类型 示例值 描述
RequestId String C6532AA8-D0F7-497F-A8EE-094126D441F5

请求ID。

TotalCount Integer 2

列表条目数。

PageNumber Integer 1

当前页码。

PageSize Integer 10

每页包含的条目数。

Vpcs Array

VPC的详细信息。

VpcId String vpc-bp1qpo0kug3a20qqe****

VPC的ID。

RegionId String cn-hangzhou

VPC所在的地域。

Status String Available

VPC的状态,取值:

  • Pending:配置中。
  • Available:可用。
VpcName String vpc1

VPC的名称。

CreationTime String 2018-04-18T15:02:37Z

VPC的创建时间。

CidrBlock String 10.0.0.0/24

VPC的IPv4网段。

Ipv6CidrBlock String 2408:4004:0:a600::/56

VPC的IPv6网段。

VRouterId String vrt-bp1jcg5cmxjbl9xgc****

VPC路由器的ID。

Description String This is my VPC.

VPC的描述信息。

IsDefault Boolean false

是否是该地域的默认VPC。

  • true:是该地域的默认VPC。
  • false:不是该地域的默认VPC。
ResourceGroupId String rg-acfmxazb4ph****

VPC所属的资源组ID。

CenStatus String Detached

VPC绑定云企业网的状态。

  • Detached:未绑定云企业网。
  • Available:已绑定云企业网。
Tags Array

VPC的标签信息。

Key String env

VPC绑定的标签键。

Value String internal

VPC绑定的标签值。

VSwitchIds List vsw-bp1nhbnpv2blyz8dl****

VPC中交换机的列表。

UserCidrs List 10.0.0.0/8

用户侧网段的列表。

NatGatewayIds List nat-245xxxftwt45bg****

NAT网关的ID。

RouterTableIds List vtb-bp1krxxzp0c29fmon****

路由表ID。

SecondaryCidrBlocks List 192.168.20.0/24

VPC的附加IPv4网段。

示例

请求示例

https://vpc.aliyuncs.com/?Action=DescribeVpcs
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式

<DescribeVpcsResponse>
  <PageNumber>1</PageNumber>
  <Vpcs>
		    <Vpc>
			      <VpcName>abc</VpcName>
			      <Description>abc</Description>
			      <IsDefault>false</IsDefault>
			      <ResourceGroupId>rg-acfmxazb4ph****</ResourceGroupId>
			      <UserCidrs></UserCidrs>
			      <NatGatewayIds></NatGatewayIds>
			      <RouterTableIds>
				        <RouterTableIds>vtb-bp1krxxzp0c29fmon****</RouterTableIds>
			      </RouterTableIds>
			      <VpcId>vpc-bp1qpo0kug3a20qqe****</VpcId>
			      <VRouterId>vrt-bp1jcg5cmxjbl9xgc****</VRouterId>
			      <CreationTime>2018-12-06T06:11:55Z</CreationTime>
			      <Status>Available</Status>
			      <CidrBlock>172.16.0.0/12</CidrBlock>
			      <VSwitchIds></VSwitchIds>
			      <RegionId>cn-hangzhou</RegionId>
			      <Ipv6CidrBlock></Ipv6CidrBlock>
		    </Vpc>
		    <Vpc>
			      <VpcName>kttest</VpcName>
			      <Description></Description>
			      <IsDefault>false</IsDefault>
			      <ResourceGroupId>rg-acfmxazb4ph****</ResourceGroupId>
			      <UserCidrs></UserCidrs>
			      <NatGatewayIds></NatGatewayIds>
			      <RouterTableIds>
				        <RouterTableIds>vtb-bp1blq1oh0ybfnpm1****</RouterTableIds>
			      </RouterTableIds>
			      <VpcId>vpc-bp1aevy8sofi8mh1q****</VpcId>
			      <VRouterId>vrt-bp149ve7yeyvio4nc****</VRouterId>
			      <CreationTime>2018-11-08T08:54:03Z</CreationTime>
			      <Status>Available</Status>
			      <CidrBlock>192.168.0.0/16</CidrBlock>
			      <VSwitchIds>
				        <VSwitchId>vsw-bp12mw1f8k3jgygk****</VSwitchId>
			      </VSwitchIds>
			      <RegionId>cn-hangzhou</RegionId>
			      <Ipv6CidrBlock></Ipv6CidrBlock>
		    </Vpc>
	  </Vpcs>
	
  <TotalCount>2</TotalCount>
  <PageSize>10</PageSize>
  <RequestId>C6532AA8-D0F7-497F-A8EE-094126D441F5</RequestId>
</DescribeVpcsResponse>

JSON 格式

{
    "PageNumber": 1,
    "Vpcs": {
        "Vpc": [
            {
                "VpcName": "abc",
                "Description": "abc",
                "IsDefault": false,
                "ResourceGroupId": "rg-acfmxazb4ph****",
                "UserCidrs": {
                    "UserCidr": []
                },
                "NatGatewayIds": {
                    "NatGatewayIds": []
                },
                "RouterTableIds": {
                    "RouterTableIds": [
                        "vtb-bp1krxxzp0c29fmon****"
                    ]
                },
                "VpcId": "vpc-bp1qpo0kug3a20qqe****",
                "VRouterId": "vrt-bp1jcg5cmxjbl9xgc****",
                "CreationTime": "2018-12-06T06:11:55Z",
                "Status": "Available",
                "CidrBlock": "172.16.0.0/12",
                "VSwitchIds": {
                    "VSwitchId": []
                },
                "RegionId": "cn-hangzhou",
                "Ipv6CidrBlock": ""
            },
            {
                "VpcName": "kttest",
                "Description": "",
                "IsDefault": false,
                "ResourceGroupId": "rg-acfmxazb4ph****",
                "UserCidrs": {
                    "UserCidr": []
                },
                "NatGatewayIds": {
                    "NatGatewayIds": []
                },
                "RouterTableIds": {
                    "RouterTableIds": [
                        "vtb-bp1blq1oh0ybfnpm1****"
                    ]
                },
                "VpcId": "vpc-bp1aevy8sofi8mh1q****",
                "VRouterId": "vrt-bp149ve7yeyvio4nc****",
                "CreationTime": "2018-11-08T08:54:03Z",
                "Status": "Available",
                "CidrBlock": "192.168.0.0/16",
                "VSwitchIds": {
                    "VSwitchId": [
                        "vsw-bp12mw1f8k3jgygk9****"
                    ]
                },
                "RegionId": "cn-hangzhou",
                "Ipv6CidrBlock": ""
            }
        ]
    },
    "TotalCount": 2,
    "PageSize": 10,
    "RequestId": "C6532AA8-D0F7-497F-A8EE-094126D441F5"
}

错误码

HttpCode 错误码 错误信息 描述
500 InternalError The request processing has failed due to some unknown error. 请求处理由于某些未知错误失败。

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