DescribeVpcs - API reference| Alibaba Cloud Documentation Center

Description

Query the created VPCs in a specified region.

Request parameters

Name	Type	Required	Description
Action	String	Yes	The action to perform. Valid value: `DescribeVpcs`
VpcId	String	No	The ID of the VPC. Up to 20 VPC IDs can be specified. Separate multiple VPC IDs by commas.
RegionId	String	Yes	The ID of the region where the VPC is located. You can query the region ID by calling DescribeRegions API.
IsDefault	Boolean	No	Whether to query the default VPC in the specified region. Valid value: `true` (Default): Query all VPCs in the specified region. `false`: Do not query the default VPC.
PageNumber	Integer	No	The number of pages to return. The default value is 1.
PageSize	Integer	No	The number of rows per page. The maximum value is 50 and default value is 10.

Response parameters

Name	Type	Description
RequestId	String	The ID of the request.
Vpcs	JSON string	The detailed information of queried VPCs. For more information, see VpcSetType.
TotalCount	String	The number of queried entries.
PageNumber	Integer	The current page number.
PageSize	Integer	The number of entries on the current page.

Error codes

For more information, see VPC API Error Center.

Examples

Request example

https://vpc.aliyuncs.com/?Action=DescribeVpcs
&RegionId=cn-beijing
&<CommonParameters>

Response example

XML format

<DescribeVpcsResponse>
    <RequestId> DA1DAE87-43FA-472F-98BB-4FDBAA4A688D</RequestId>
    <Vpcs>
        <Vpc>
            <VpcId> vpc-257gq642n </VpcId>
            <RegionId>cn-beijing</RegionId>
            <VpcName></VpcName>
            <Description></Description>
            <VRouterId>vrt-25bezkd03</VRouterId>
            <Status>Available</Status>
            <UserCidrs></UserCidrs>
            <CidrBlock>172.16.0.0/16</CidrBlock>
            <VSwitchIds></VSwitchIds>
            <CreationTime> 2014-10-29T13:30:19Z</CreationTime>
        </Vpc>
    </Vpcs>
</DescribeVpcsResponse>

JSON format

{
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "DA1DAE87-43FA-472F-98BB-4FDBAA4A688D",
  "TotalCount": 1,
  "Vpcs": {
    "Vpc": {
      "CidrBlock": "172.16.0.0/16",
      "CreationTime": "2014-10-29T13:30:19Z",
      "Description": "",
      "RegionId": "cn-beijing",
      "Status": "Available",
      "UserCidrs": {
        "UserCidr": []
      },
      "VRouterId": "vrt-25bezkd03",
      "VSwitchIds": {
        "VSwitchId": []
      },
      "VpcId": "vpc-257gq642n",
      "VpcName": ""
    }
  }
}