RenewInstance - ApsaraDB RDS - Alibaba Cloud Documentation Center

You can call the RenewInstance operation to manually renew an ApsaraDB RDS instance.

Operation Description

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.
NoteBy default, coupons available for your account are preferentially used for payment.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
rds:RenewInstance	WRITE	RDS acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	none

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	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.	ETnLKlblzczshOTUbOCzxxxxxxxxxx
DBInstanceId	string	Yes	The ID of the instance.	rm-uf6wjk5xxxxxxxxxx
Period	integer	Yes	The duration of the subscription renewal. Unit: months. Valid values: 1~9 12 24 36 48 60	12
AutoPay	string	No	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.	True
AutoRenew	string	No	Specifies whether to enable auto-renewal for the instance. Valid values: true. false. This is the default value.	true

Response parameters

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

Examples

Sample success responses

JSONformat

{
  "OrderId": 201815745430941,
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF\t"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidConcurrentOperate	Concurrent operation is detected.	Concurrent operations exist. Wait until the previous operation is complete and try again.
400	ArrearageOrderExists	Your account has an outstanding balance.	Add funds to your Alibaba Cloud account, complete the overdue payments, and then try again.

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2022-09-01

The error codes of the API operation change.

Change item	Change content
Error Codes	The error codes of the API operation change.
	Error Codes 400 change