All Products
Search
Document Center

AnalyticDB:ModifyAutoRenewalAttribute

Last Updated:Jan 08, 2026

Configures auto-renewal for a subscription cluster.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
adb:ModifyAutoRenewalAttributeupdate
*DBClusterLakeVersion
acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of cluster.

amv-uf6pl56w1j8h****
RegionIdstringYes

The region ID.

cn-hangzhou
AutoRenewalStatusstringNo

The renewal method. Valid values:

  • AutoRenewal: The cluster is automatically renewed.
  • Normal: The cluster is manually renewed. Before the cluster expires, the system sends you a reminder by SMS message.
  • NotRenewal: The cluster is not renewed. Reminders are only sent three days before cluster expiration.
AutoRenewal
AutoRenewalPeriodstringNo

The duration of the auto-renewal. Default value: 1. Valid values:

  • When AutoRenewalPeriod is set to Month, the value ranges from 1 to 11 (integer).
  • When AutoRenewalPeriod is set to Month, the valid values are 1, 2, 3, and 5 (integer).
Note Longer renewal periods offer better pricing. Renewing for 1 year is more cost-effective than renewing for 10 or 11 months.
1
AutoRenewalPeriodUnitstringNo

Auto-renewal duration. Valid values:

  • Year.
  • Month.
Year

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

421794A3-72A5-5D27-9E8B-A75A4C503E17

Examples

Sample success responses

JSONformat

{
  "RequestId": "421794A3-72A5-5D27-9E8B-A75A4C503E17"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2025-12-16Add OperationView Change Details