Queries the auto-renewal status of subscription PolarDB clusters.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No DescribeAutoRenewAttribute

The operation that you want to perform. Set the value to DescribeAutoRenewAttribute.

RegionId String Yes cn-hangzhou

The ID of the region.

Note You can call the DescribeRegions operation to query the region ID details.
DBClusterIds String No pc-****************

The ID of the cluster. If you need to specify multiple cluster IDs, separate the cluster IDs with commas (,).

PageSize Integer No 30

The number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30.

PageNumber Integer No 1

The page number. The value must be an integer that is larger than 0 and does not exceed the maximum value of the INTEGER data type. Default value: 1.

ResourceGroupId String No rg-re*********

The ID of the resource group.

Response parameters

Parameter Type Example Description
Items Array of AutoRenewAttribute

The renewal information about the clusters.
AutoRenewAttribute
AutoRenewEnabled Boolean true

Indicates whether the auto-renewal feature is enabled. Valid values:

  • true: enabled
  • false: disabled
DBClusterId String pc-*****************

The ID of the cluster.
Duration Integer 4

The renewal duration.
PeriodUnit String Month

The unit of the duration. Valid values:

  • Year
  • Month
RegionId String cn-hangzhou

The ID of the region.
RenewalStatus String AutoRenewal

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.
PageNumber Integer 1

The page number of the returned page.
PageRecordCount Integer 1

The total number of pages returned.
RequestId String 65D7ACE6-4A61-4B6E-B357-8CB24A******

The ID of the request.
TotalRecordCount Integer 1

The total number of entries.

Examples

Sample requests

http(s)://polardb.aliyuncs.com/? Action=DescribeAutoRenewAttribute
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format 

<DescribeAutoRenewAttributeResponse>
  <TotalRecordCount>1</TotalRecordCount>
  <PageRecordCount>1</PageRecordCount>
  <RequestId>65D7ACE6-4A61-4B6E-B357-8CB24A******</RequestId>
  <PageNumber>1</PageNumber>
  <Items>
        <AutoRenewAttribute>
              <AutoRenewEnabled>true</AutoRenewEnabled>
              <DBClusterId>pc-*****************</DBClusterId>
              <RenewalStatus>AutoRenewal</RenewalStatus>
              <Duration>4</Duration>
              <RegionId>cn-hangzhou</RegionId>
              <PeriodUnit>Month</PeriodUnit>
        </AutoRenewAttribute>
  </Items>
</DescribeAutoRenewAttributeResponse>

JSON format 

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

Error codes

For a list of error codes, visit the API Error Center.