All Products
Search
Document Center

ApsaraDB RDS:RenewInstance

Last Updated:Jan 16, 2024

Manually renews an instance.

Operation description

Supported database engines

  • MySQL
  • PostgreSQL
  • SQL Server
  • MariaDB

References

Note Fees of an instance are changed if the call is successful. Before you call this operation, carefully read the following topics:

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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.
OperationAccess levelResource typeCondition keyAssociated operation
rds:RenewInstanceWRITE
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the generated token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

ETnLKlblzczshOTUbOCzxxxxxxxxxx
DBInstanceIdstringYes

The instance ID You can call the DescribeDBInstances operation to query the instance ID.

rm-uf6wjk5xxxxxxxxxx
PeriodintegerYes

The duration of the subscription renewal. Unit: month. Valid values:

  • 1~9
  • 12
  • 24
  • 36
  • 48
  • 60
12
AutoPaystringNo

Specifies whether to enable automatic payment during the renewal. Valid values:

  • True: enables automatic payment. Make sure that your Alibaba Cloud account has adequate balance.
  • False (default): disables automatic payment. You have to manually pay the order in the console.
True
AutoRenewstringNo

Specifies whether to enable auto-renewal for the instance. Valid values:

  • true.
  • false (default)
true

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

OrderIdlong

The order ID.

201815745430941
RequestIdstring

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 codeError codeError messageDescription
400InvalidConcurrentOperateConcurrent operation is detected.Concurrent operations exist. Wait until the previous operation is complete and try again.
400ArrearageOrderExistsYour 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 timeSummary of changesOperation
2022-09-01The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change