说明:当前页面接口为旧版 API,未来可能停止维护,目前不展示在左侧导航。云服务器 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 云服务器 API 3.0。
1. 接口描述
本接口 (UpdateInstanceBandwidth) 用于调整包年包月实例的公网带宽。
接口请求域名:cvm.api.qcloud.com
- 只针对包年包月实例和带宽包用户。按量计费实例调整带宽需要使用 UpdateInstanceBandwidthHour API。
- 只允许升级带宽,不允许降低带宽值。
- 按流量计费实例带宽最大为100Mbps;按带宽计费模式实例最大为200Mbps;专用宿主机的实例最大宽带为1000Mbps。
- 只支持按带宽计费方式。
2. 输入参数
以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 页面。
参数名称 | 是否必选 | 类型 | 描述 |
---|---|---|---|
instanceId | 是 | String | 待操作的实例ID。可通过 DescribeInstances API返回值中的 unInstanceId 获取。 |
bandwidth | 是 | Int | 升级后的带宽值(Mbps)。升级后的带宽不能小于当前带宽。 |
startTime | 是 | String | 起始时间。格式如:2016-10-30,该时间不能早于当前时间;如果是今天则为立即生效。 |
endTime | 是 | String | 终止时间。格式如:2017-11-30,修改带宽的有效期包含此日期,该时间不能晚于实例过期的时间;实例的到期时间可以使用 DescribeInstances API 查询。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 公共错误码。0表示成功,其他值表示失败。 |
message | String | 模块错误信息描述,与接口相关。 |
dealIds | Array | 生成的订单号,用于查询执行情况。 |
4. 示例
输入
https://cvm.api.qcloud.com/v2/index.php?Action=UpdateInstanceBandwidth &instanceId=qcvm12345 &bandwidth=2 &startTime=2014-07-20 &endTime=2014-08-20 &<公共请求参数>
输出
- 注意,如果该实例的网络为按流量计费模式,没有dealIds。
{
"code" : 0,
"message" : "ok",
"dealIds":[
12194872988
]
}