DescribeAutoRenewAttribute - PolarDB - Alibaba Cloud Documentation Center

Queries the auto-renewal attributes of a subscription PolarDB 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:
- 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
polardb:DescribeAutoRenewAttribute	list	DBCluster acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region. Note You can call the DescribeRegions operation to query the region ID details.	cn-hangzhou
DBClusterIds	string	No	The ID of the cluster. If you need to specify multiple cluster IDs, separate the cluster IDs with commas (,).	pc-****************
PageSize	integer	No	The number of entries per page. Valid values: 30, 50, and 100. Default value: 30.	30
PageNumber	integer	No	The page number. The value must be an integer that is greater than 0. Default value: 1.	1
ResourceGroupId	string	No	The ID of the resource group.	rg-re*********

Response parameters

Parameter	Type	Description	Example
	object
Items	array<object>	The renewal information about the clusters.
AutoRenewAttribute	object
AutoRenewEnabled	boolean	Indicates whether the auto-renewal feature is enabled. Valid values: true: enabled false: disabled	true
DBClusterId	string	The ID of the cluster.	pc-*****************
Duration	integer	The renewal duration.	4
PeriodUnit	string	The unit of the duration. Valid values: Year Month	Month
RegionId	string	The ID of the region.	cn-hangzhou
RenewalStatus	string	The renewal status. Valid values: AutoRenewal: The cluster is automatically renewed. Normal: The cluster is manually renewed. The system sends a text message to remind you before the cluster expires. NotRenewal: The cluster is not renewed. The system does not send a reminder for expiration but only sends a text message three days before the cluster expires to remind you that the cluster is not renewed.	AutoRenewal
PageNumber	integer	The page number of the page returned.	1
PageRecordCount	integer	The total number of pages returned.	1
RequestId	string	The ID of the request.	65D7ACE6-4A61-4B6E-B357-8CB24A******
TotalRecordCount	integer	The total number of entries.	1

Examples

Sample success responses

JSONformat

{
  "Items": {
    "AutoRenewAttribute": [
      {
        "AutoRenewEnabled": true,
        "DBClusterId": "pc-*****************",
        "Duration": 4,
        "PeriodUnit": "Month",
        "RegionId": "cn-hangzhou",
        "RenewalStatus": "AutoRenewal"
      }
    ]
  },
  "PageNumber": 1,
  "PageRecordCount": 1,
  "RequestId": "65D7ACE6-4A61-4B6E-B357-8CB24A******",
  "TotalRecordCount": 1
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidRegionId.Malformed	The specified parameter RegionId is not valid.	The specified RegionId parameter is invalid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	The specified PageSize parameter is invalid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.	The specified PageNumber parameter is invalid.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	The request failed to be processed because unknown errors, exceptions, or failures have occurred.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	A temporary server error occurred.

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

Change history

Change time	Summary of changes	Operation

No change history