有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

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

  • 不同机型带宽上限范围不一致,具体限制详见公网带宽上限
  • 对于 BANDWIDTH_PREPAID 计费方式的带宽,需要输入参数 StartTimeEndTime ,指定调整后的带宽的生效时间段。在这种场景下目前不支持调小带宽,会涉及扣费,请确保账户余额充足。可通过 [DescribeAccountBalance] https://cloud.tencent.com/document/product/555/20253) 接口查询账户余额。
  • 对于 TRAFFIC_POSTPAID_BY_HOURBANDWIDTH_POSTPAID_BY_HOURBANDWIDTH_PACKAGE 计费方式的带宽,使用该接口调整带宽上限是实时生效的,可以在带宽允许的范围内调大或者调小带宽,不支持输入参数 StartTimeEndTime
  • 接口不支持调整 BANDWIDTH_POSTPAID_BY_MONTH 计费方式的带宽。
  • 接口不支持批量调整 BANDWIDTH_PREPAIDBANDWIDTH_POSTPAID_BY_HOUR 计费方式的带宽。
  • 接口不支持批量调整混合计费方式的带宽。例如不支持同时调整 TRAFFIC_POSTPAID_BY_HOURBANDWIDTH_PACKAGE 计费方式的带宽。
  • 实例操作结果可以通过调用 DescribeInstances 接口查询,如果实例的最新操作状态(LatestOperationState)为“SUCCESS”,则代表操作成功。

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

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 计费方式的带宽时,只支持一个实例。
示例值:["ins-r8hr2upy"]
InternetAccessible InternetAccessible 公网出带宽配置。不同机型带宽上限范围不一致,具体限制详见带宽限制对账表。暂时只支持 InternetMaxBandwidthOut 参数。
StartTime String 带宽生效的起始时间。格式:YYYY-MM-DD,例如:2016-10-30。起始时间不能早于当前时间。如果起始时间是今天则新设置的带宽立即生效。该参数只对包年包月带宽有效,其他模式带宽不支持该参数,否则接口会以相应错误码返回。
示例值:2017-03-15
EndTime String 带宽生效的终止时间。格式: YYYY-MM-DD ,例如:2016-10-30 。新设置的带宽的有效期包含终止时间此日期。终止时间不能晚于包年包月实例的到期时间。实例的到期时间可通过 DescribeInstances接口返回值中的ExpiredTime获取。该参数只对包年包月带宽有效,其他模式带宽不支持该参数,否则接口会以相应错误码返回。
示例值:2017-03-16

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

本示例用于调整一个实例的公网带宽上限。

输入示例

GET 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 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.NotFoundEIP 当前实例没有弹性IP
InternalError.TradeUnknownError 内部错误
InternalServerError 操作内部错误。
InvalidAccount.InsufficientBalance 账户余额不足。
InvalidAccount.UnpaidOrder 账户有未支付订单。
InvalidInstance.NotSupported 不被支持的实例。
InvalidInstanceId.Malformed 无效实例ID。指定的实例ID格式错误。例如实例ID长度错误ins-1122
InvalidInstanceId.NotFound 没有找到相应实例。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.BandwidthPackageIdMalformed 共享带宽包ID不合要求,请提供规范的共享带宽包ID,类似bwp-xxxxxxxx,字母x代表小写字符或者数字。
InvalidParameterValue.InstanceIdMalformed 实例ID不合要求,请提供规范的实例ID,类似ins-xxxxxxxx,字母x代表小写字符或数字。
InvalidParameterValue.InvalidAppIdFormat 无效的appid。
InvalidParameterValue.LimitExceeded 参数值数量超过限制。
InvalidParameterValue.Range 无效参数值。参数值取值范围不合法。
InvalidPermission 账户不支持该操作。
MissingParameter 缺少参数错误。
MutexOperation.TaskRunning 同样的任务正在运行。
OperationDenied.InstanceOperationInProgress 实例正在执行其他操作,请稍后再试。
UnsupportedOperation.BandwidthPackageIdNotSupported 指定的实例付费模式或者网络付费模式不支持共享带宽包
UnsupportedOperation.EdgeZoneInstance 边缘可用区实例不支持此项操作。
UnsupportedOperation.InstanceChargeType 请求不支持该实例计费模式
UnsupportedOperation.InstanceReinstallFailed 当前实例为重装系统失败状态,不支持此操作;推荐您再次重装系统,也可以销毁/退还实例或提交工单
UnsupportedOperation.InstanceStateBanning 该子机处于封禁状态,请联系相关人员处理。
UnsupportedOperation.InstanceStateEnterServiceLiveMigrate 不支持状态为 ENTER_SERVICE_LIVE_MIGRATE.的实例 ins-xxxxxx
UnsupportedOperation.InstanceStateExitServiceLiveMigrate 不支持状态为 EXIT_SERVICE_LIVE_MIGRATE.的实例 ins-xxxxxx
UnsupportedOperation.InstanceStateFreezing 操作不支持已冻结的实例。
UnsupportedOperation.InstanceStateIsolating 请求不支持正在隔离状态的实例。
UnsupportedOperation.InstanceStatePending 请求不支持创建未完成的实例
UnsupportedOperation.InstanceStateRebooting 请求不支持正在重启的实例
UnsupportedOperation.InstanceStateRescueMode 请求不支持救援模式的实例
UnsupportedOperation.InstanceStateShutdown 请求不支持隔离状态的实例
UnsupportedOperation.InstanceStateStarting 实例开机中,不允许该操作。
UnsupportedOperation.InstanceStateStopping 请求不支持正在关机的实例
UnsupportedOperation.InstanceStateTerminating 请求不支持正在销毁的实例
UnsupportedOperation.StoppedModeStopCharging 不支持关机不收费特性