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. It must be up to 50 characters in length. You can call the DescribeRegions operation to query the most recent region list.
DBClusterIds String No pc-**************** The ID of the cluster. Separate multiple 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 number of the page to return. Valid values: 1 to 2147483647. Default value: 1.
ResourceGroupId String No rg-re********* The ID of the resource group.

Response parameters

Parameter Type Example Description
Items Array The renewal information of the clusters.
AutoRenewAttribute
AutoRenewEnabled Boolean true Indicates whether the auto-renewal feature is enabled. Valid values:
  • true: enabled
  • false: disabled
DBClusterId String pc-xxxxxxxxxxxxxxxx The ID of the cluster.
Duration Integer 1 The renewal duration of the subscription cluster.
PeriodUnit String Month The unit of the renewal duration. Valid values:
  • Year
  • Month
RegionId String cn-hangzhou The region ID of the instance.
RenewalStatus String AutoRenewal 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 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 an SMS 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 8ABD1FF2-85B1-4D03-8C99-FB603B****** The ID of the request.
TotalRecordCount Integer 1 The total number of entries returned.

Examples

Sample requests

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

Sample success responses

XML format 

<Items>
    <AutoRenewAttribute>
        <RenewalStatus>AutoRenewal</RenewalStatus>
        <Duration>1</Duration>
        <RegionId>cn-hangzhou</RegionId>
        <AutoRenewEnabled>true</AutoRenewEnabled>
        <PeriodUnit>Month</PeriodUnit>
        <DBClusterId>pc-****************</DBClusterId>
    </AutoRenewAttribute>
</Items>
<TotalRecordCount>1</TotalRecordCount>
<PageNumber>1</PageNumber>
<RequestId>8ABD1FF2-85B1-4D03-8C99-FB603B******</RequestId>
<PageRecordCount>1</PageRecordCount>

JSON format 

{
    "Items": {
        "AutoRenewAttribute": [
            {
                "RenewalStatus": "AutoRenewal",
                "Duration": 1,
                "RegionId": "cn-hangzhou",
                "AutoRenewEnabled": true,
                "PeriodUnit": "Month",
                "DBClusterId": "pc-****************"
            }
        ]
    },
    "TotalRecordCount": 1,
    "PageNumber": 1,
    "RequestId": "8ABD1FF2-85B1-4D03-8C99-FB603B******",
    "PageRecordCount": 1
}

Error codes

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