edit-icon download-icon


Last Updated: Apr 10, 2018


Note:Ensure that you have learned about RDS billing methods and pricing before using this API.

Manually renew an instance.

This API is applicable only to Subscription instances.

Request parameters

Name Type Required Example value Description
Action String Yes RenewInstance

Name of this interface. Value: RenewInstance

DBInstanceId String Yes rm-bp1842vmucoa5w874

Instance ID

Period String Yes 6

Renewal period. Values are 1 to 9, 12, 24, and 36. (Unit: month)

AutoPay String No True Whether to enable automatic payment. Values:
  • True: Your account automatically pays for the renewal. Ensure that your account has sufficient balance.
  • False: You need to manually complete the payment as follows: Log on to the console, choose Billing Management > Orders at the upper right corner, and pay for the order.
If the request does not include this parameter, the value is False by default.

Response parameters

Name Type Example value Description
RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

Request ID.

OrderId String 201815745430941

Order ID.


Request example

  1. https://rds.aliyuncs.com/?Action=RenewInstance
  2. &DBInstanceId=rm-bp11g72jcsup6s04e
  3. &Period=1
  4. &AutoPay=True
  5. &<Common request parameters>

Success response example

JSON format

  1. {
  2. "RequestId":"1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC",
  3. "OrderId":"201815745430941"
  4. }

Error response example

JSON format

  1. {
  2. "Code":"UnsupportedOperation",
  3. "HostId":"rds.aliyuncs.com",
  4. "Message":"The specified action is not supported.",
  5. "RequestId":"7463B73D-35CC-4D19-A010-6B8D65D242EF"
  6. }

Error codes

API Error Center

Thank you! We've received your feedback.