调用EnableAdditionalBandwidth调整Redis实例的带宽。

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

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

调用本接口时，要求Redis实例为社区版或企业版（性能增强型或混合存储型），且Redis实例为本地盘实例。更多信息，请参见本地盘和云盘实例对比。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 EnableAdditionalBandwidth

系统规定参数，取值：EnableAdditionalBandwidth。

InstanceId String 是 r-bp1zxszhcgatnx****

实例ID，可调用DescribeInstances获取。

Bandwidth String 是 20

要增加的带宽，单位为MB/s。取值为大于等于0的整数 ，最大可传入当前实例规格默认最大带宽的2倍。例如实例规格的默认最大带宽为10 MB/s，本参数的取值范围为0~20。

说明
  • 您可以调用DescribeRoleZoneInfo接口，通过返回参数DefaultBandWidth获取默认最大带宽。更多关于实例规格的信息，请参见实例规格查询导航。
  • 如果请求参数NodeId传入了多个数据分片ID，本参数传入的带宽值需和数据分片ID的顺序对应，多个带宽值之间使用英文逗号（,）分隔。
OrderTimeLength String 否 30

购买的时长，单位为天，取值：1、2、3、7、14、30、60、90、180、365、730、1095、1825。

说明 如果需要继续使用购买的带宽，您需要在带宽到期前调用RenewAdditionalBandwidth接口及时续费。
RegionId String 否 cn-hangzhou

实例所属地域的ID，可调用DescribeInstances获取。

CouponNo String 否 youhuiquan_promotion_option_id_for_blank

优惠券编号。
AutoPay Boolean 否 true

是否自动付款，取值：

  • true：默认值，自动付款，请确保账号有足够的余额。
  • false：手动付款。您需要在控制台的顶部菜单栏，单击费用 > 续费管理，然后单击左侧导航栏的订单管理 > 我的订单，找到目标订单进行支付。
NodeId String 否 r-bp1zxszhcgatnx****-db-0

数据分片ID，您可以调用DescribeLogicInstanceTopology获取，传入多个时使用英文逗号（,）分隔；您也可以传入ALL（即表示所有数据分片）。

说明 当Redis实例为集群架构或读写分离架构时，本参数才可用且必须传入。
SourceBiz String 否 SDK

调用来源，本参数仅用于内部维护使用，无需传入。
AutoRenew Boolean 否 false

是否开启自动续费，取值：

  • true：开启。
  • false：不开启，默认值。
AutoRenewPeriod Integer 否 1

自动续费周期，单位为月，取值：1、2、3、4、5、6、7、8、9、12、24、36、60。

说明
  • 当AutoRenew参数取值为true时，本参数才可用且必须传入。
  • 该参数设置后暂不支持通过API查询，您可以在控制台的顶部菜单栏，单击费用 > 续费管理，然后在实例ID文本框中输入实例ID加-bw后缀（例如r-bp1zxszhcgatnx-bw）来查询。

返回数据

名称 类型 示例值 描述
OrderId String 2084452111111

订单ID。
RequestId String D622714-AEDD-4609-9167-F5DDD3D1****

请求ID。

示例

请求示例

https://r-kvstore.aliyuncs.com/?Action=EnableAdditionalBandwidth
&InstanceId=r-bp1zxszhcgatnx****
&Bandwidth=20
&OrderTimeLength=30
&<公共请求参数>

正常返回示例

XML格式 

<EnableAdditionalBandwidthResponse>
      <RequestId>D622714-AEDD-4609-9167-F5DDD3D1****</RequestId>
      <OrderId>2084452111111</OrderId>
</EnableAdditionalBandwidthResponse>

JSON格式 

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

错误码

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