All Products
Search
Document Center

Alibaba Cloud Service Mesh:DescribeVpcs

Last Updated:Mar 05, 2024

Queries the virtual private clouds (VPCs) that are available in a specified region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

TotalCountinteger

The total number of entries returned. By default, this parameter is not returned.

10
RequestIdstring

The request ID.

BD65C0AD-D3C6-48D3-8D93-38D2015C****
NextTokenstring

The token that marks the end of the current returned page. If this parameter is empty, it indicates that you have retrieved all the data.

""
MaxResultsinteger

The maximum number of entries returned on a single page.

10
Vpcsobject []

The list of VPCs that are available in the specified region.

VpcIdstring

The ID of a VPC.

vpc-bp1qkf2o3xmqc2519****
VpcNamestring

The name of the VPC.

vpc-test
Statusstring

The status of the VPC. Valid values:

  • Pending: The VPC is being configured.
  • Available: The VPC is available for use.
Available
IsDefaultboolean

Indicates whether the VPC is the default VPC in the specified region. Valid values:

  • true: yes
  • false: no
false

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.