You can call this operation to query the auto-renewal attribute of AnalyticDB for MySQL clusters billed in the subscription mode.

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 Yes DescribeAutoRenewAttribute

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

DescribeAutoRenewAttribute.
RegionId String Yes cn-hangzhou

The region ID of the cluster.
DBClusterIds String No am-bp1xxxxxxxx47

The ID of the cluster.

Specify multiple cluster IDs with commas (,).
PageSize Integer No 30

The number of entries to return on each page. Valid values:

  • 30
  • 50
  • 100

Default value: 30.
PageNumber Integer No 1

The page number of the returned page. Valid values: the positive integer.

Default value: 1.
ResourceGroupId String No rg-rexxxxxxxxxx

The ID of the resource group.

Response parameters

Parameter Type Example Description
Items Array of AutoRenewAttribute

The renewal information of the clusters.
AutoRenewAttribute
AutoRenewEnabled Boolean true

Specifies whether to enable auto-renewal.

  • true
  • false
DBClusterId String am-bp1xxxxxxxx47

The ID of the cluster.
Duration Integer 1

The renewal duration.
PeriodUnit String Year

The unit of the renewal period.

  • Year
  • Month
RegionId String cn-hangzhou

The region ID of the cluster.
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 page returned.
PageRecordCount Integer 2

The total number of pages returned.
RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

The ID of the request.
TotalRecordCount Integer 20

The total number of entries.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeAutoRenewAttribute
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format 

<TotalRecordCount>20</TotalRecordCount>
<PageRecordCount>2</PageRecordCount>
<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
<PageNumber>1</PageNumber>
<Items>
    <AutoRenewAttribute>
        <AutoRenewEnabled>true</AutoRenewEnabled>
        <DBClusterId>am-bp1xxxxxxxx47</DBClusterId>
        <RenewalStatus>AutoRenewal</RenewalStatus>
        <Duration>1</Duration>
        <RegionId>cn-hangzhou</RegionId>
        <PeriodUnit>Year</PeriodUnit>
    </AutoRenewAttribute>
</Items>

JSON format 

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

Error codes

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