DescribeAutoRenewalAttribute - AnalyticDB - Alibaba Cloud Documentation Center

Queries the auto-renewal status of 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.

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:
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
adb:DescribeAutoRenewalAttribute	get	*DBClusterLakeVersion `acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
DBClusterId	array	No	The cluster IDs.
	string	No	The cluster ID.	am-bp1u8c0mgfg58****
PageSize	integer	No	The number of entries returned on each page. Valid values: 30(Default) 50 100	30
PageNumber	integer	No	The page number. A positive integer greater than 0 and not exceeding the maximum value of the Integer data type. Default value: 1.	1
ResourceGroupId	string	No	The resource group ID.	rg-4690g37929****

Response parameters

Parameter	Type	Description	Example
	object
TotalRecordCount	integer	The total number of entries returned.	20
PageRecordCount	integer	The number of entries returned on each page.	30
RequestId	string	The request ID.	BA0F6761-7A8C-59F8-9624-FB56788C0EDF
PageNumber	integer	The page number of the returned page.	1
Items	array<object>	The list of auto-renewal details.
AutoRenewalAttribute	object
DBClusterId	string	The cluster ID.	amv-uf6485635fz8****
AutoRenewalPeriodUnit	string	The unit of auto-renewal duration. Valid values: Year Month	Year
AutoRenewalPeriod	long	The auto-renewal duration.	1
AutoRenewalStatus	string	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
AutoRenewalEnabled	boolean	Indicates whether auto-renewal is enabled for the cluster. Valid values: true: Enables. false: Disables.	true
RegionId	string	The region ID.	cn-shenzhen

Examples

Sample success responses

JSONformat

{
  "TotalRecordCount": 20,
  "PageRecordCount": 30,
  "RequestId": "BA0F6761-7A8C-59F8-9624-FB56788C0EDF",
  "PageNumber": 1,
  "Items": {
    "AutoRenewalAttribute": [
      {
        "DBClusterId": "amv-uf6485635fz8****",
        "AutoRenewalPeriodUnit": "Year",
        "AutoRenewalPeriod": 1,
        "AutoRenewalStatus": "AutoRenewal",
        "AutoRenewalEnabled": true,
        "RegionId": "cn-shenzhen"
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2025-12-16	Add Operation	View Change Details