Renews an RDS instance.

Before you call this API action, make sure that you fully understand the pricing of ApsaraDB for RDS. For more information, see ApsaraDB RDS for MySQL pricing.

The instance must meet the following requirements:

  • The instance uses the subscription billing method.
  • Your Alibaba Cloud account has sufficient balance or has been bound to a credit card.
Note Coupons under your account are preferentially used during payment.

Debug

You can use API Explorer to perform debugging.

OpenAPI Explorer provides various functions to simplify API usage. For example, you can retrieve APIs, call APIs, and generate SDK sample code.

Request parameters

Parameter Type Required Example Description
Action String Yes RenewInstance

The name of API action. Value: RenewInstance.

DBInstanceId String Yes rm-uf6wjk5xxxxxxxxxx

The ID of the instance.

Period String Yes 12

The renewal period. Unit: months. Valid values:

  • 1 to 9
  • 12
  • 24
  • 36
  • 48
  • 60
ClientToken String No ETnLKlblzczshOTUbOCzxxxxxxxxxx

The client token that is used to guarantee the idempotency of requests. The parameter value is generated by the client and is unique among different requests, which is a string of up to 64 ASCII characters.

AutoPay String No True

Indicates whether automatic payment is enabled. Valid values:

  • True: Automatic payment is enabled. Make sure that your account has sufficient balance.
  • False: Automatic payment is disabled. You must pay on the console as follows: Log on to the console. In the upper-right corner, choose Billing Management > Billing Management. On the Billing Management page, choose Bills. On the Unpaid tab, click Make a Payment in the Actions column.

Default value: False.

AccessKeyId String No LTAIfCxxxxxxxxxx

The AccessKey ID issued by Alibaba Cloud for users to access services.

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

Request example

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

Normal response examples

XML format:

<RenewInstanceResponse> 
  <OrderId>20286717xxxxx</OrderId> 
  <RequestId>E10319A3-B96A-46B0-81CE-D610DC891409</RequestId> 
</RenewInstanceResponse> 

JSON format:

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

Errors

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