Doc CenterSign in to zenConsole

DescribeVpcs

DescribeVpcs

1. API Description

This API is used to query the details of one or more 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

VPC IDs.

You can query up to 100 networks in each request.

cidrBlock

No

String

CIDR block of the subnet. Fuzzy query is supported.

zoneId

No

String

Zone ID.

vpcStatus

No

String

VPC Status.

vpcName

No

String

VPC name. 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.

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

Information on VPCs.

totalCount

Integer

Number of subnets meeting the filtering conditions.

4. Code Example

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

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

Request:
{
  "vpcIds": ["xxxx","xxx"],
  "cidrBlock": "10.0.0.0/24",
  "zoneId": "SIN-Z",
  "vpcStatus": "Available",
  "vpcName": "xxx",
  "pageSize": 10,
  "pageNum": 1
}

Response:
{
    "requestId": "T1EB061B4-E20D-4CE5-8EF7-63073E1AB3E1",
    "response": {
        "requestId": "T1EB061B4-E20D-4CE5-8EF7-63073E1AB3E1",
        "dataSet": [
            {
                "vpcId": "914782535395847474",
                "zoneId": "SIN-Z",
                "createTime": "2023-06-16T03:49:36Z",
                "vpcName": "xxxx",
                "vpcStatus": "Available",
                "isDefault": true,
                "cidrBlock": "10.0.0.0/24",
                "subnetIdList": [
                    "xxxx",
                    "xxxx"
                ]
            }
        ],
        "totalCount": 1
    }
}

5. Developer Resources

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

6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.​

HTTP Status Code
Error Code
Description

500

DESCRIBE_SUBNET_FAILED

Query exception.

500

UNKNOW_SUBNET_STATUS

Abnormal subnet status.

Last updated