DescribeDatacenters

DescribeDatacenters

1. API Description

This API is used to query data centers available.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter NameRequiredTypeDescription

dcIds

No

Array of String

Codes of data centers, consisting of IATA airport codes and numbers.

isPortAvailable

No

Boolean

Filter data centers in which whether port creation is supported or not.

  • true: Port creation is supported in this data center.

  • false: Port creation is not supported in this data center.

By default, data centers in which port creation is not supported are filtered.

3. Output Parameters

Parameter NameTypeDescription

requestId

String

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

dcSet

The list of data centers available.

4. Code Example

Query data center information by the dcId SIN1.

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

Request: 
{
    "dcIds": ["SIN1"]
}

Response: 
{
    "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
    "response": {
        "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
        "dcSet": [{
            "dcId":"SIN1",
            "dcName":"AP-Singapore1",
            "cityName":"Singapore",
            "areaName":"Asia Pacific",
            "countryName":"Singapore",
            "dcAddress":"20 Ayer Rajah Crescent, Ayer Rajah Industrial Park, Singapore 139964"
        }]
    }
}

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