DescribeAutoRenewAttribute - AnalyticDB - Alibaba Cloud Documentation Center

Queries the auto-renewal status of a subscription AnalyticDB for MySQL cluster.

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.

Operation	Access level	Resource type	Condition key	Associated operation
adb:DescribeAutoRenewAttribute	get	DBCluster acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the cluster.	cn-hangzhou
DBClusterIds	string	Yes	The cluster ID. Separate multiple clusters with commas (,).	am-bp11q28kvl688****
PageSize	integer	No	The number of entries per page. Valid values: 30 50 100 Default value: 30.	30
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
ResourceGroupId	string	No	The ID of the resource group.	rg-4690g37929****

Response parameters

Parameter	Type	Description	Example
	object
TotalRecordCount	integer	The total number of entries returned.	20
PageRecordCount	integer	The number of entries per page.	30
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
PageNumber	integer	The page number.	1
Items	array<object>	The renewal information of the cluster.
	object
DBClusterId	string	The cluster ID.	am-bp11q28kvl688****
PeriodUnit	string	The unit of the renewal duration. Valid values: Year Month	Year
Duration	integer	The renewal duration.	1
RenewalStatus	string	The renewal status of the cluster. 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. Three days before the cluster expires, the system sends you a reminder by SMS message to remind you that the cluster is not renewed. However, the system does not send you a reminder when the cluster expires.	AutoRenewal
AutoRenewEnabled	boolean	Indicates whether auto-renewal is enabled for the cluster. Valid values: true false	true
RegionId	string	The region ID of the cluster.	cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "TotalRecordCount": 20,
  "PageRecordCount": 30,
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "PageNumber": 1,
  "Items": {
    "AutoRenewAttribute": [
      {
        "DBClusterId": "am-bp11q28kvl688****",
        "PeriodUnit": "Year",
        "Duration": 1,
        "RenewalStatus": "AutoRenewal",
        "AutoRenewEnabled": true,
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2022-12-23	API Description Update	View Change Details