DescribeVpcs - Alibaba Cloud Service Mesh - Alibaba Cloud Documentation Center

Call DescribeVpcs to retrieve available VPCs in a specified region.

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 support 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

servicemesh:DescribeVpcs

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	Region ID	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object	Response parameters
TotalCount	integer	The total amount of data under the current request conditions. This parameter is optional and can be omitted by default	10
RequestId	string	Request ID	BD65C0AD-D3C6-48D3-8D93-38D2015C****
NextToken	string	Indicates the position where the current call returns reading to. Empty indicates that all data has been read	""
MaxResults	integer	The maximum number of records returned by this request	10
Vpcs	array<object>	List of available VPCs in the specified region
	object	Available VPC in the specified region
VpcId	string	The ID of the VPC	vpc-bp1qkf2o3xmqc2519****
VpcName	string	VPC name	vpc-test
Status	string	The status of the VPC, values: `Pending`: Configuring `Available`: Available	Available
IsDefault	boolean	Whether it is the default VPC for the region, values: `true`: Default VPC `false`: Not the default VPC	false

Examples

Success response

JSON format

{
  "TotalCount": 10,
  "RequestId": "BD65C0AD-D3C6-48D3-8D93-38D2015C****",
  "NextToken": "\"\"",
  "MaxResults": 10,
  "Vpcs": [
    {
      "VpcId": "vpc-bp1qkf2o3xmqc2519****",
      "VpcName": "vpc-test",
      "Status": "Available",
      "IsDefault": false
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.