Renews the bandwidth of an ApsaraDB for Redis instance.

Before you call this operation, make sure that you understand the billing methods and prices of ApsaraDB for Redis. For more information, see Billing items and pricing.

You can adjust the bandwidth of an instance in the ApsaraDB for Redis console. For more information, see Adjust the maximum bandwidth value of an 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.

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 RenewAdditionalBandwidth

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

InstanceId String Yes r-bp1zxszhcgatnx****

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

OrderTimeLength String Yes 30

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.

RegionId String No cn-hangzhou

The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

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: Automatic payment is enabled. This is the default value.
  • false: Automatic payment is disabled. 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 page that appears, find the order and complete the payment.
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.

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

http(s)://r-kvstore.aliyuncs.com/?Action=RenewAdditionalBandwidth
&InstanceId=r-bp1zxszhcgatnx****
&OrderTimeLength=30
&<Common request parameters>

Sample success responses

XML format

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

JSON format

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

Error codes

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