EnableAdditionalBandwidth - 调整实例带宽 - 云原生内存数据库Tair

调整Redis实例的带宽。

接口说明

关于该功能费用说明、限制及常见问题，请参见调整实例带宽。

说明调用本接口前，您可以调用DescribeRoleZoneInfo查询实例中各数据节点的当前带宽。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
kvstore:EnableAdditionalBandwidth	Write	Redis acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例ID，可调用DescribeInstances获取。	r-bp1zxszhcgatnx****
CouponNo	string	否	优惠券编号。	youhuiquan_promotion_option_id_for_blank
AutoPay	boolean	否	是否自动付款，取值： true：默认值，自动付款，请确保账号有足够的余额。 false：手动付款。您需要在控制台的顶部菜单栏，单击费用 > 续费管理，然后单击左侧导航栏的订单管理 > 我的订单，找到目标订单进行支付。	true
NodeId	string	否	数据分片ID，您可以调用DescribeLogicInstanceTopology获取，传入多个时使用英文逗号（,）分隔；您也可以传入All（即表示所有数据分片）。说明当Redis实例为集群架构或读写分离架构时，本参数才可用且必须传入。	r-bp1zxszhcgatnx****-db-0
Bandwidth	string	是	要增加的带宽，单位为MB/s。取值为大于等于0的整数，最大可传入当前实例规格默认最大带宽的2倍。例如实例规格的默认最大带宽为10 MB/s，本参数的取值范围为0~20。说明您可以调用DescribeRoleZoneInfo接口，通过返回参数DefaultBandWidth获取默认最大带宽。更多关于实例规格的信息，请参见实例规格查询导航。如果请求参数NodeId传入了多个数据分片ID，本参数传入的带宽值需和数据分片ID的顺序对应，多个带宽值之间使用英文逗号（,）分隔。	20
OrderTimeLength	string	否	购买的时长，单位为天，取值：1、2、3、7、14、30、60、90、180、365、730、1095、1825。说明如果需要继续使用购买的带宽，您需要在带宽到期前调用RenewAdditionalBandwidth接口及时续费。	30
SourceBiz	string	否	调用来源，本参数仅用于内部维护使用，无需传入。	SDK
AutoRenew	boolean	否	是否开启自动续费，取值： true：开启。 false：不开启，默认值。	false
AutoRenewPeriod	integer	否	自动续费周期，单位为月，取值：1、2、3、4、5、6、7、8、9、12、24、36、60。说明当AutoRenew参数取值为true时，本参数才可用且必须传入。该参数设置后暂不支持通过API查询，您可以在控制台的顶部菜单栏，单击费用 > 续费管理，然后在实例ID文本框中输入实例ID加`-bw`后缀（例如r-bp1zxszhcgatnx****-bw）来查询。	1

返回参数

名称	类型	描述	示例值
	object
OrderId	string	订单ID。	2084452111111
RequestId	string	请求ID。	D622714-AEDD-4609-9167-F5DDD3D1****

示例

正常返回示例

JSON格式

{
  "OrderId": "2084452111111",
  "RequestId": "D622714-AEDD-4609-9167-F5DDD3D1****"
}

错误码

访问错误中心查看更多错误码。