DescribeCloudRouterAvailableVpcs

1. API Description

This API is used to query available VPCs that can be added into a Layer 3 cloud router.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
vpcId	No	String	VPC ID。
pageNum	No	Integer	Number of pages returned. Default value: 1.
pageSize	No	Integer	Number of items in the current page result. Default value: 20; Maximum value: 1000.

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 CloudRouterAvailableVpc	Information on VPCs.
totalCount	Integer	Number of VPCs meeting the filtering conditions.

4. Code Example

Example

Query available VPCs that can be added into a Layer 3 cloud router.

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

Request：
{}

Response：
{   
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId":"TB1F3B1A1-DA70-4FF7-99D1-CEBEEFBAC95F",
    "totalCount":1,
    "dataSet":[
        {
            "vpcName":"VPC-MAD-A-01",
            "dataCenter":{
                "dcId":"MAD1",
                "cityName":"Madrid",
                "areaName":"Europe",
                "dcName":"Interxion_MAD2 ",
                "dcAddress":"Calle Albasanz, 73, Madrid, 28037, Spain",
                "countryName":"Spain"
            },
            "vpcId":"your-vpc-id",
            "cidrBlock":"10.0.0.0/8"
        }
    ]
  }
}

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

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