DescribeCloudAvailableBandwidthTiers

1. 接口描述

调用本接口查询云连接可用的带宽阶梯信息。

注意事项

• 修改云连接带宽限速时请使用cloudPortId参数查询目标云连接可用的带宽阶梯。

• 若返回结果为空说明云连接当前暂无可用带宽。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

名称	类型	必选	描述
cloudPortId	String	否	云连接ID。修改云连接带宽限速时请使用该参数，其他参数将被忽略。
cloudType	String	否	云连接类型。可选值： AWS TENCENT GOOGLE AZURE ALI_CLOUD HUAWEI_CLOUD BYTE_PLUS ORACLE
cloudAccountId	String	否	云平台账号。 Google 云此处为Pairing Key，如何获取请参考Google云配置。 Azure 云此处为Service Key。如何获取请参考Azure云配置。
cloudRegionId	String	否	公有云区域ID。 Google云无需传参
dcId	String	否	连接云接入点的数据中心ID。
vlanId	Integer	否	VLAN ID。

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID。 每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
availableBandwidthTiers	Array of Integer	云连接可用的带宽阶梯。

4. 代码示例

示例

1. 创建时查询可用的带宽阶梯

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. 修改云连接限速时查询可用的带宽阶梯

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. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

HTTP状态码	错误码	说明
404	INVALID_CLOUD_PORT_NOT_FOUND	云连接不存在。