All Products
Document Center

ApsaraDB for Redis:ModifyInstanceAutoRenewalAttribute

Last Updated:Jun 18, 2024

Enables or disables auto-renewal for an ApsaraDB for Redis instance.

Operation description

Note Auto-renewal is triggered seven days before the expiration date of the instance.


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

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
  • All Resources

Request parameters


The ID of the instance. Separate multiple instance IDs with commas (,).

Note You can specify up to 30 instance IDs.

The auto-renewal period. Valid values: 1 to 12. Unit: months. When the instance is about to expire, the instance is automatically renewed based on the number of months specified by this parameter.

Note This parameter is available and required only if the AutoRenew parameter is set to true.

Specifies whether to enable auto-renewal. Valid values:

  • true: enables auto-renewal.
  • false: disables auto-renewal.
Note The default value is false.

Response parameters


The ID of the request.



Sample success responses


  "RequestId": "52D901ED-E0A5-42FB-B9DB-39C295C3****"

Error codes

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

Change history

Change timeSummary of changesOperation
2023-03-02The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.