Manually renew an ApsaraDB RDS instance -

Before you call this operation, make sure that you understand the billing methods and pricing of ApsaraDB RDS. For more information, see Billable items, billing methods, and pricing.

Before you call this operation, make sure that the following requirements are met:

The instance is a subscription instance.
Your account supports credit card payments or balance payments.

Note By default, coupons available for your account are preferentially used for payment.

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.
ClientToken	String	No	ETnLKlblzczshOTUbOCzxxxxxxxxxx	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that the generated token is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.
DBInstanceId	String	Yes	rm-uf6wjk5xxxxxxxxxx	The ID of the instance.
Period	Integer	Yes	12	The duration of the subscription renewal. Unit: months. Valid values: 1~9 12 24 36 48 60
AutoPay	String	No	True	Specifies whether to enable automatic payment during the renewal. Valid values: True: Automatic payment is enabled. Make sure that your Alibaba Cloud account has adequate balance. False: Automatic payment is disabled. You have to manually pay the order in the console. Log on to the ApsaraDB RDS console. In the upper-right corner, choose Expenses > User Center. In the left-side navigation pane, click Orders. On the page that appears, find your order and complete the payment.
AutoRenew	String	No	true	Specifies whether to enable auto-renewal for the instance. Valid values: true. false. This is the default value.

Response parameters


Parameter	Type	Example	Description
OrderId	Long	201815745430941	The ID of the order.
RequestId	String	1AD222E9-E606-4A42-BF6D-8A4442913CEF	The ID of the request.

Examples

Sample requests

http(s)://rds.aliyuncs.com/?Action=RenewInstance
&DBInstanceId=rm-uf6wjk5xxxxxxxxxx
&Period=12
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<RenewInstanceResponse>
    <OrderId>20286717xxxxx</OrderId>
    <RequestId>E10319A3-B96A-46B0-81CE-D610DC891409</RequestId></RenewInstanceResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "OrderId" : "20286717xxxxx",
  "RequestId" : "E10319A3-B96A-46B0-81CE-D610DC891409"
}

Error codes


HTTP status code	Error code	Error message	Description
400	SYSTEM.CONCURRENT_OPERATE	Concurrent operation is detected.	The error message returned because concurrent operations are performed in the system.
400	ArrearageOrderExists	Your account has an outstanding balance.	The error message returned because your Alibaba Cloud account has an outstanding balance.

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