DescribeCloudAvailableBandwidthTiers

1. API Description

This API is used to query available cloud connect access bandwidth specifications.

Note

• Use parameter cloudPortId to query available cloud connect access bandwidth specifications when modifying the bandwidth.

• If the returned result is empty, it indicates that no bandwidth specification is currently available for the Cloud Connect.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Type	Required	Description
cloudPortId	No	String	Cloud Connect ID. When modifying the Cloud Connect access bandwidth, use this parameter. All other parameters will be ignored.
cloudType	No	String	Cloud Connect types. Available values: AWS TENCENT GOOGLE AZURE ALI_CLOUD HUAWEI_CLOUD BYTE_PLUS ORACLE
cloudAccountId	No	String	oud account ID. For Google Cloud, pass the value of Pairing Key. See Google Cloud Configuration for more details. For Microsoft Azure, pass the value of Service Key. See Microsoft Azure Configuration for more details.
cloudRegionId	No	String	Public cloud region ID. The value is not needed for Google Cloud.
dcId	No	String	Data center ID.
vlanId	No	Integer	VLAN ID.

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.
availableBandwidthTiers	Array of Integer	Available cloud connect access bandwidth specifications

4. Code Example

Example

1. Query available bandwidth specifications when creating.

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

Request：
{
    "cloudType": "AWS",
    "cloudRegionId": "us-east-1",
    "dcId": "0cd74ed4-e0cf-43c8-9c9b-567a1287227a",
    "vlanId": 1024,
    "cloudPortId": null,
    "cloudAccountId": null
}

Response：
{
    "requestId": "T266C5563-6D98-42E9-8E62-84DF5849F8EC",
    "response": {
        "requestId": "T266C5563-6D98-42E9-8E62-84DF5849F8EC",
        "availableBandwidthTiers": [
            50,
            100,
            200,
            300,
            400,
            500,
            1000,
            2000,
            5000
        ]
    }
}

2. Query available bandwidth specifications when modifying the Cloud Connect bandwidth.

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

Request：
{
    "cloudPortId": "your-cloud-port-id"
}

Response：
{
    "requestId": "T266C5563-6D98-42E9-8E62-84DF5849F8EC",
    "response": {
        "requestId": "T266C5563-6D98-42E9-8E62-84DF5849F8EC",
        "availableBandwidthTiers": [
            50,
            100,
            200,
            300,
            400,
            500,
            1000,
            2000,
            5000
        ]
    }
}

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
404	INVALID_CLOUD_PORT_NOT_FOUND	Cloud Connect does not exist.