DescribeVpcs - Elastic Compute Service - Alibaba Cloud Documentation Center

Query VPCs

Note

This API has been deprecated. We recommend migrating to Vpc(2016-04-28) - DescribeVpcs for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:DescribeVpcs

get

*All Resource

*

vpc:tag

None

Request parameters

Parameter	Type	Required	Description	Example
VpcId	string	No	The ID of the VPC.
RegionId	string	Yes	The ID of the region.
IsDefault	boolean	No	Specifies whether the VPC is a default VPC. Set to `true` to query the default VPC, or `false` to query non-default VPCs.
PageNumber	integer	No	The page number. Default: 1.
PageSize	integer	No	The number of entries to return on each page. Default: 10. Valid values: 1 to 50.

Response elements

Element	Type	Description	Example
	object	The response body.
PageSize	integer	The number of entries per page.
RequestId	string	The request ID.
PageNumber	integer	The page number.
TotalCount	integer	The total number of entries.
Vpcs	object	The details of the VPCs.
Vpc	array<object>	An array of VPCs.
	array<object>
CreationTime	string	The creation time of the VPC.
VpcName	string	The name of the VPC.
Status	string	The status of the VPC.
VpcId	string	The ID of the VPC.
VRouterId	string	The ID of the VRouter associated with the VPC.
IsDefault	boolean	Indicates whether the VPC is the default VPC in the region.
CidrBlock	string	The CIDR block of the VPC.
Description	string	The description of the VPC.
RegionId	string	The ID of the region to which the VPC belongs.
VSwitchIds	object	The VSwitches in the VPC.
VSwitchId	array	An array of VSwitch IDs.
	string	The ID of a VSwitch.
UserCidrs	object	The user CIDR blocks of the VPC.
UserCidr	array	An array of user CIDR blocks.
	string	A user CIDR block.

Examples

Success response

JSON format

{
  "PageSize": 0,
  "RequestId": "",
  "PageNumber": 0,
  "TotalCount": 0,
  "Vpcs": {
    "Vpc": [
      {
        "CreationTime": "",
        "VpcName": "",
        "Status": "",
        "VpcId": "",
        "VRouterId": "",
        "IsDefault": false,
        "CidrBlock": "",
        "Description": "",
        "RegionId": "",
        "VSwitchIds": {
          "VSwitchId": [
            ""
          ]
        },
        "UserCidrs": {
          "UserCidr": [
            ""
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidAliuid	User Id is not valid.
400	InvalidResourceGroupId.NotFound	The Specified ResourceGroupId not exists.
400	OperationUnsupported.ResourceGroupId	%s
400	InvalidVpcIdNumber.NotSupported	The number of vpcIds exceeds the limit.
400	InvalidTagKey	The tag keys are not valid.
400	InvalidTagValue	The tag values are not valid.
400	IellgalParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.
400	OperationFailed.Endpoint	Operation failed because the RegionId is unavailable in this endpoint.
500	InternalError	The request processing has failed due to some unknown error.
404	InvalidRegionId.NotFound	The specified RegionId is not found.	The specified RegionId parameter does not exist. Check whether the service is available in the specified region.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.