All Products
Document Center


Last Updated:Feb 20, 2024

Renews the purchased bandwidth for an ApsaraDB for Redis instance.

Operation description

Before you call this operation, make sure that you understand the billing methods and pricing of ApsaraDB for Redis.

You can adjust the bandwidth of an instance in the ApsaraDB for Redis console. For more information, see Adjust the bandwidth of an ApsaraDB for Redis instance. You can also call the EnableAdditionalBandwidth operation to adjust the bandwidth of an instance. If you want to continue using the bandwidth that you purchase after the validity period of the bandwidth, you must call the RenewAdditionalBandwidth operation to renew the bandwidth before the bandwidth expires.

Note Before you call this operation, you can call the DescribeIntranetAttribute operation, which returns the expiration time of the purchased bandwidth in the BandwidthExpireTime parameter.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
  • All Resources

Request parameters


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


The ID of the coupon.


Specifies whether to enable automatic payment. Default value: true. Valid values:

  • true: enables automatic payment.
  • false: disables automatic payment. If automatic payment is disabled, you must perform the following steps to complete the payment in the ApsaraDB for Redis console: In the top navigation bar, choose Expenses > Renewal Management. In the left-side navigation pane, click Orders. On the Orders page, find the order and complete the payment.

The validity period of the bandwidth that you purchase. Unit: days. Valid values: 1, 2, 3, 7, 14, 30, 60, 90, 180, 365, 730, 1095, and 1825.


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


Response parameters


The ID of the order.


The ID of the request.



Sample success responses


  "OrderId": "2084452111111",
  "RequestId": "D622714-AEDD-4609-9167-F5DDD3D1****\t"

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-07-20API Description Updatesee changesets
Change itemChange content
API DescriptionAPI Description Update.