调整云数据库 Tair(兼容 Redis)实例的带宽,当前仅支持按量付费的计费方式,您仅需填写InstanceId、NodeId(可选)、Bandwidth、ChargeType参数即可。
接口说明
若您在调用本接口的同时,开启了实例带宽弹性伸缩功能,则实例会优先使用带宽弹性伸缩功能,且在带宽弹性回缩时,将回缩至实例规格的默认带宽。更多关于该功能限制、费用说明及常见问题,请参见调整实例带宽。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
kvstore:EnableAdditionalBandwidth | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 实例 ID,可调用 DescribeInstances 获取。 | r-bp1zxszhcgatnx**** |
CouponNo | string | 否 | 优惠券编号。 | youhuiquan_promotion_option_id_for_blank |
AutoPay | boolean | 否 | 是否自动付款,取值:
| true |
NodeId | string | 否 | 数据分片 ID,您可以调用 DescribeLogicInstanceTopology 获取,传入多个时使用英文逗号(,)分隔;您也可以传入 All(即表示所有数据分片)。 | r-bp1zxszhcgatnx****-db-0 |
Bandwidth | string | 是 | 要增加的带宽,单位为 MB/s。取值为大于等于 0 的整数 ,最大可传入该实例(或单分片)规格默认带宽的 6 倍,但增加的上限为 192MB/s。例如实例默认带宽为 10 MB/s,可增加的范围为 0~60。 说明
| 20 |
OrderTimeLength | string | 否 | 购买的时长,单位为天,取值:1、2、3、7、14、30、60、90、180、365、730、1095、1825。 说明
如果需要继续使用购买的带宽,您需要在带宽到期前调用 RenewAdditionalBandwidth 接口及时续费。
| 30 |
SourceBiz | string | 否 | 调用来源,本参数仅用于内部维护使用,无需传入。 | SDK |
AutoRenew | boolean | 否 | 是否开启自动续费,取值:
| false |
AutoRenewPeriod | integer | 否 | 自动续费周期,单位为月,取值:1、2、3、4、5、6、7、8、9、12、24、36、60。 说明
-bw 后缀(例如 r-bp1zxszhcgatnx****-bw)来查询。 | 1 |
ChargeType | string | 是 | 额外增加带宽的付费类型,取值:
| PrePaid |
返回参数
示例
正常返回示例
JSON
格式
{
"OrderId": "2084452111111",
"RequestId": "D622714-AEDD-4609-9167-F5DDD3D1****"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-06-06 | OpenAPI 入参发生变更 | 查看变更详情 |