Adjusts the bandwidth of an ApsaraDB for Redis instance.

For more information about the fees, limits, and answers to some frequently asked questions about bandwidth adjustments, see Adjust the bandwidth of an ApsaraDB for Redis instance.

Note Before you call this operation, you can call the DescribeRoleZoneInfo operation to query the bandwidth of each data shard in the instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes EnableAdditionalBandwidth

The operation that you want to perform. Set the value to EnableAdditionalBandwidth.

InstanceId String Yes r-bp1zxszhcgatnx****

The ID of the instance. You can call the DescribeInstances operation to query the IDs of instances.

Bandwidth String Yes 20

The amount of bandwidth that you want to purchase. Unit: MB/s. The value of this parameter must be an integer that is greater than or equal to 0. You can set this parameter to a value that is up to two times the default bandwidth that is supported by the instance type. For example, if the default bandwidth that is supported by the instance type is 10 MB/s, you can set this parameter to a value within the range of 0 to 20.

Note
  • You call the DescribeRoleZoneInfo operation to query the default bandwidth that is supported by an instance type. In the response, the default bandwidth is indicated by the DefaultBandWidth parameter. For more information about instance types, see Overview.
  • If you specify multiple data shard IDs in the NodeId parameter, you must specify the amount of bandwidth that you want to purchase for each specified data shard in the Bandwidth parameter. The bandwidth values that you specify in the Bandwidth parameter must be in the same sequence as the data shard IDs that you specify in the NodeId parameter. In addition, you must separate the bandwidth values with commas (,).
OrderTimeLength String No 30

The period of time for which the purchased bandwidth is valid. Unit: days. Valid values: 1, 2, 3, 7, 14, 30, 60, 90, 180, 365, 730, 1095, and 1825.

Note If you want to continue using the purchased bandwidth after the specified period of time elapses, you must call the RenewAdditionalBandwidth operation to submit a renewal order.
RegionId String No cn-hangzhou

The region ID of the instance. You can call the DescribeInstances operation to query the region IDs of instances.

CouponNo String No youhuiquan_promotion_option_id_for_blank

The ID of the coupon that you want to use.

AutoPay Boolean No true

Specifies whether to enable automatic payment. Valid values:

  • true: enables automatic payment. Make sure that your Alibaba Cloud account has a sufficient balance.
  • false: disables automatic payment. To manually complete the payment, you can perform the following procedure: In the top navigation bar of the ApsaraDB for Redis console, choose Expenses > Renewal Management. In the left-side navigation pane of the Billing Management console, click Orders. On the page that appears, find the order and complete the payment.
NodeId String No r-bp1zxszhcgatnx****-db-0

The ID of the data shard for which you want to purchase a specific amount of bandwidth. You can call the DescribeLogicInstanceTopology operation to query the IDs of the data shards in an instance. If you specify multiple data shard IDs, separate the data shard IDs with commas (,). You can also set this parameter to ALL, which specifies all the data shards of the instance.

Note This parameter takes effect and must be specified only when the instance is a cluster master-replica instance or a read/write splitting instance. For more information, see Cluster master-replica instances or Read/write splitting instances.
SourceBiz String No SDK

The source of the operation. This parameter is used only for internal maintenance. You do not need to specify this parameter.

AutoRenew Boolean No false

Specifies whether to enable auto-renewal. Valid values:

  • true: enables auto-renewal.
  • false: disables auto-renewal. This is the default value.
AutoRenewPeriod Integer No 1

The auto-renewal cycle based on which ApsaraDB for Redis automatically renews the purchased bandwidth. Unit: months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, and 60.

Note
  • This parameter takes effect and must be specified only when you set the AutoRenew parameter to true.
  • You cannot query the auto-renewal cycle by calling an API operation. To obtain the auto-renewal cycle, you can perform the following procedure: In the top navigation bar of the ApsaraDB for Redis console, choose Expenses > Renewal Management. On the page that appears, enter the ID of the instance and the -bw suffix in the Instance ID field. Example: r-bp1zxszhcgatnx-bw.

Response parameters

Parameter Type Example Description
OrderId String 2084452111111

The ID of the order.

RequestId String D622714-AEDD-4609-9167-F5DDD3D1****

The ID of the request.

Examples

Sample requests

https://r-kvstore.aliyuncs.com/?Action=EnableAdditionalBandwidth
&InstanceId=r-bp1zxszhcgatnx****
&Bandwidth=20
&OrderTimeLength=30
&<Common request parameters>

Sample success responses

XML format

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

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.