Use DescribeAutoRenewAttribute to query the auto-renewal status of a cluster - AnalyticDB - Alibaba Cloud - AnalyticDB

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

adb:DescribeAutoRenewAttribute

get

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

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 elements

Element	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	object
AutoRenewAttribute	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. The system sends an SMS reminder before the cluster expires. NotRenewal: The cluster is not renewed. The system sends an SMS reminder three days before expiration but does not send a reminder when the cluster expires.	AutoRenewal
AutoRenewEnabled	boolean	Whether auto-renewal is enabled for the cluster. Valid values: true false	true
RegionId	string	The region ID of the cluster.	cn-hangzhou

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.