DescribeAzureVlanUsage

1. API Description

This API is used to query VLAN usage of the Azure Cloud access point.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter NameRequiredTypeDescription

dcId

Yes

String

Data center ID of the access point.

pairingKey

Yes

String

Azure Cloud Account ID.

3. Output Parameters

Parameter NameRequiredDescription

requestId

String

The unique request ID, which is returned for each request. RequestId is required for locating a problem.

start

Integer

Start value of available VLANs.

end

Integer

End value of available VLANs.

usedVlans

Array of Integer

Used VLAN list.

4. Code Example

Query VLAN usage of Azure Cloud access point according to Azure Cloud service key.

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

Request:
{
   "pairingKey": "xxxxxxxxxxxxx/asia-southeast1/1"
}

Response:
{   
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId":"T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "usedVlans":[
        1024,
        1025,
        2,
        1026,
        1027
    ],
    "start":2,
    "end":4000
  }
}

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.​

Last updated