You can call this operation to renew an ApsaraDB for Redis 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 No RenewInstance

The operation that you want to perform. Set the value to RenewInstance.
InstanceId String Yes r-bp1xxxxxxxxxxxxx

The ID of the instance.
Period Long Yes 6

The renewal period of the instance. Unit: months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, and 36.

RegionId String No cn-hangzhou

The ID of the region where the instance is deployed.
Capacity String No 1024

The storage capacity of the instance. Unit: MB. You can set this parameter to renew and change specifications of an instance.

Note To change the specifications during renewal, you must specify the Capacity or InstanceClass parameter.
InstanceClass String No redis.master.small.default

The instance type code.. For more information, see Specifications overview. You can set this parameter to renew and change specifications of an instance.

Note To change the specifications during renewal, you must specify the Capacity or InstanceClass parameter.
AutoPay Boolean No true

Specifies whether to enable auto-renewal for the instance. Valid values:

  • true (default value).
  • false: Auto-renewal is disabled. You must manually renew the instance in the console.
Note
  • This parameter is only applicable to subscription-based instances.
  • Manually renew the instance in the console: Log on to the console. In the upper-right corner, choose Billing > Orders and find the target order in the Pending Payment state, and then complete the payment.
FromApp String No OpenApi

Specifies the request source. The default value is OpenApi and cannot be changed.
BusinessInfo String No 000000000

The ID of the promotion or the business information.
CouponNo String No youhuiquan_promotion_option_id_for_blank

The coupon code. Default value: youhuiquan_promotion_option_id_for_blank.

Response parameters

Parameter Type Example Description
RequestId String 2222245-222A-4155-9349-E222222220

The ID of the request.
OrderId String 111111111111111

The ID of the order.
EndTime String 2019-02-19T00:00:00Z

The end time of the order.

Examples

Sample requests

https://r-kvstore.aliyuncs.com/
?Action=RenewInstance
&InstanceId=r-bp1xxxxxxxxxxxxx
&Period=6
&<Common request parameters>

Sample success responses

XML format 

<RenewInstanceResponse>
      <OrderId>111111111111111</OrderId>
      <RequestId>4D425645-A8BA-4155-9349-22222222222</RequestId>
      <EndTime>2019-02-19T00:00:00Z</EndTime>
</RenewInstanceResponse>

JSON format 

{
    "OrderId": "111111111111111",
    "RequestId": "2222245-222A-4155-9349-E222222220",
    "EndTime": "2019-02-19T00:00:00Z"
}

Error codes

HttpCode Error code Error message Description
400 HasRenewChangeOrder This instance has a renewChange order. The error message returned because an order of renewal with specifications change already exists.

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