调整实例带宽上限

最近更新时间:2018-10-12 16:02:32

1. 接口描述

接口请求域名: cvm.tencentcloudapi.com 。

本接口 (ResetInstancesInternetMaxBandwidth) 用于调整实例公网带宽上限。

  • 不同机型带宽上限范围不一致,具体限制详见购买网络带宽
  • 对于 BANDWIDTH_PREPAID 计费方式的带宽,需要输入参数 StartTimeEndTime ,指定调整后的带宽的生效时间段。在这种场景下目前不支持调小带宽,会涉及扣费,请确保账户余额充足。可通过 DescribeAccountBalance 接口查询账户余额。
  • 对于 TRAFFIC_POSTPAID_BY_HOURBANDWIDTH_POSTPAID_BY_HOURBANDWIDTH_PACKAGE 计费方式的带宽,使用该接口调整带宽上限是实时生效的,可以在带宽允许的范围内调大或者调小带宽,不支持输入参数 StartTimeEndTime
  • 接口不支持调整 BANDWIDTH_POSTPAID_BY_MONTH 计费方式的带宽。
  • 接口不支持批量调整 BANDWIDTH_PREPAIDBANDWIDTH_POSTPAID_BY_HOUR 计费方式的带宽。
  • 接口不支持批量调整混合计费方式的带宽。例如不支持同时调整 TRAFFIC_POSTPAID_BY_HOURBANDWIDTH_PACKAGE 计费方式的带宽。

默认接口请求频率限制:10次/每秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi )时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cvm.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ResetInstancesInternetMaxBandwidth
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
InstanceIds.N Array of String 一个或多个待操作的实例ID。可通过DescribeInstances接口返回值中的 InstanceId 获取。 每次请求批量实例的上限为100。当调整 BANDWIDTH_PREPAIDBANDWIDTH_POSTPAID_BY_HOUR 计费方式的带宽时,只支持一个实例。
InternetAccessible InternetAccessible 公网出带宽配置。不同机型带宽上限范围不一致,具体限制详见带宽限制对账表。暂时只支持 InternetMaxBandwidthOut 参数。
StartTime String 带宽生效的起始时间。格式:YYYY-MM-DD,例如:2016-10-30。起始时间不能早于当前时间。如果起始时间是今天则新设置的带宽立即生效。该参数只对包年包月带宽有效,其他模式带宽不支持该参数,否则接口会以相应错误码返回。
EndTime String 带宽生效的终止时间。格式: YYYY-MM-DD ,例如:2016-10-30 。新设置的带宽的有效期包含终止时间此日期。终止时间不能晚于包年包月实例的到期时间。实例的到期时间可通过 DescribeInstances接口返回值中的ExpiredTime获取。该参数只对包年包月带宽有效,其他模式带宽不支持该参数,否则接口会以相应错误码返回。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

4. 示例

示例1 调整实例公网带宽上限

输入示例

https://cvm.tencentcloudapi.com/?Action=ResetInstancesInternetMaxBandwidth
&InstanceIds.0=ins-r8hr2upy
&InternetAccessible.InternetMaxBandwidthOut=10
&StartTime=2017-03-15
&EndTime=2017-03-16
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "d39d6c09-44e9-4e80-8661-77b5ff3cbc15"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、 SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集( SDK ),支持多种编程语言,能更方便的调用 API 。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
InternalServerError 操作内部错误。
InvalidAccount.InsufficientBalance 账户余额不足。
InvalidAccount.UnpaidOrder 账户有未支付订单。
InvalidInstance.NotSupported 不被支持的实例。
InvalidInstanceId.Malformed 无效实例ID。指定的实例ID格式错误。例如实例ID长度错误ins-1122
InvalidInstanceId.NotFound 没有找到相应实例。
InvalidParameter 无效参数。参数不合要求或者参数不被支持等。
InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
InvalidParameterValue.Range 无效参数值。参数值取值范围不合法。
InvalidPermission 账户不支持该操作。
MissingParameter 参数缺失。请求没有带必选参数。

如果有其他疑问,你也可以通过提问形式与我们联系探讨