Renews an ApsaraDB for Redis instance.

This operation applies to only subscription instances.

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 RenewInstance

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

InstanceId String Yes r-bp1zxszhcgatnx****

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 change specifications of an instance when you renew the instance.

Note To change the specifications when you renew the instance, you must set at least one of the following parameters: Capacity and InstanceClass.
InstanceClass String No redis.master.small.default

The instance type code. For more information, see Instance specifications overview. You can set this parameter to change specifications of an instance when you renew the instance.

Note To change the specifications when you renew the instance, you must set at least one of the following parameters: Capacity and InstanceClass.
AutoPay Boolean No true

Specifies whether to enable automatic payment for the instance. Valid values:

  • true: enables automatic payment. This is the default value.
  • false: disables automatic payment.

If you select false, you must choose Expenses > Renewal Management in the top navigation bar. In the left-side navigation pane, click Orders. Find the specified order and pay for it.

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 event 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
EndTime String 2019-02-19T00:00:00Z

The end time of the order.

OrderId String 111111111111111

The ID of the order.

RequestId String 2222245-222A-4155-9349-E22222****

The ID of the request.

Examples

Sample requests

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

Sample success responses

XML format

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

JSON format

{
    "OrderId": "111111111111111",
    "RequestId": "2222245-222A-4155-9349-E22222****",
    "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 a renewal order with specifications change already exists.

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