ModifyCloudBandwidth

1. 接口描述

调用本接口用于修改一个云连接的带宽限速。

circle-info

注意事项

  • 可以通过调用DescribeCloudAvailableBandwidthTiers 接口查询到云连接可用的带宽阶梯。

  • AWS云、Oracle云不支持修改带宽限速,Azure云只支持带宽扩容。

  • 如果是二层网络专线的云连接,可以通过调用DescribePrivateConnects 接口查询到endpointId即为云连接ID。

  • 如果是三层网络的云连接,可以通过调用DescribeCloudRouters 接口查询到接入点的portId即为云连接ID。

  • 本接口为异步接口,此时带宽修改操作并未立即完成,在此期间云连接的所属的二层网络专线或者三层网络状态将会处于UPDATING 。如果是二层网络专线,结果可以通过调用DescribePrivateConnects 接口查询,如果状态(privateConnectStatus)由 UPDATING(修改中)变为AVAILABLE(可用),则代表带宽更新成功。如果是三层网络,结果可以通过调用DescribeCloudRouters 接口查询,如果状态( cloudRouterStatus)由 UPDATING(修改中)变为RUNNING(可用),则代表带宽更新成功。

  • 在修改带宽期间,不得对该云连接以及所属的二层网络专线或者三层网络进行其他任何操作。

  • 请注意,调用本接口对云连接进行带宽限速的修改之后,后续再通过ModifyPrivateConnectBandwidthModifyCloudRouterEdgePointBandwidth 接口进行带宽的修改时将只能修改骨干带宽,而不再自动修改云连接的带宽。

2. 请求参数

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

参数名称
必选
类型
描述

cloudPortId

String

需要修改的云连接ID。

bandwidthMbps

Integer

需要修改的带宽限速。 必须匹配带宽的阶梯,可以通过调用DescribeCloudAvailableBandwidthTiers接口查询到可用的带宽阶梯。

单位:Mbps。

3. 响应结果

参数名称
类型
描述

requestId

String

唯一请求 ID。

每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 代码示例

1. 修改云连接的带宽为100Mbps.

5. 开发者工具

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

6. 错误码

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

HTTP状态码
错误码
说明

404

INVALID_CLOUD_PORT_NOT_FOUND

云连接不存在。

400

INVALID_PORT_STATUS

状态不可用,无法进行操作。

403

INVALID_CLOUD_BANDWIDTH

无效的带宽值,带宽值必须匹配带宽阶梯。

最后更新于