DescribeVpcs

DescribeVpcs

1. API Description

This API is used to query the details of one or more global VPCs. You can filter the query results with the VPC ID and name.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
vpcIds	No	Array of String	Global VPC IDs.
name	No	String	Global VPC name. Fuzzy query is supported.
cidrBlock	No	String	CIDR block of the subnet. Fuzzy query is supported.
pageSize	No	Integer	Number of items in the current page result. Default value: 20; Maximum value: 1000.
pageNum	No	Integer	Number of pages returned. Default value: 1.
resourceGroupId	No	String	Resource group id.
tagKeys	No	Array of String	Query using tag keys. A maximum of 20 tag keys can be used.
tags	No	Array of Tag	Query using tags. A maximum of 20 tags can be used.

3. Output Parameters

Parameter Name	Type	Description
requestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.
dataSet	Array of VpcInfo	Information on global VPCs.
totalCount	Integer	Number of global VPCs meeting the filtering conditions.

4. Code Example

Example

Query all the available global VPCs with a CIDR block of 10.0.0.0/24.

POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeVpcs
<Common Request Params>

Request：
{
  "cidrBlock": "10.0.0.0/24",
  "pageSize": 10,
  "pageNum": 1
}

Response：
{
  "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
    "dataSet": [
      {
        "vpcId": "xxx",
        "name": "xxx",
        "cidrBlock": "10.0.0.0/8",
        "ipv6CidrBlock": "",
        "mtu": 1000,
        "isDefault": true,
        "createTime": "2022-01-01T01:00:00Z",
        "usageIpv4Count": 256,
        "securityGroupId": "xxx",
        "resourceGroup":{
          "resourceGroupId": "<resourceGroupId>",
          "resourceGroupName": "Test"
        },
        "tags":null
      }
    ],
    "totalCount": 1
  }
}

5. Developer Resources

Zenlayer Cloud API 2.0 SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

No error codes related to the API business logic. For other error codes, see Common Error Codes.​