Queries the auto-renewal status of subscription AnalyticDB for MySQL 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 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 Yes am-bp11q28kvl688****

The ID of the cluster.

Separate multiple clusters 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 number of the page to return. The value must be an integer that is greater than 0.

Default value: 1

ResourceGroupId String No rg-4690g37929****

The ID of the resource group.

Response parameters

Parameter Type Example Description
TotalRecordCount Integer 20

The total number of entries returned.

PageRecordCount Integer 30

The number of entries returned per page.

RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

The ID of the request.

PageNumber Integer 1

The page number of the returned page.

Items Array of AutoRenewAttribute

The renewal information of the cluster.

AutoRenewAttribute
DBClusterId String am-bp11q28kvl688****

The ID of the cluster.

PeriodUnit String Year

The unit of the renewal period. Valid values:

  • Year
  • Month
Duration Integer 1

The renewal period.

RenewalStatus String AutoRenewal

The renewal status of the cluster. Valid values:

  • AutoRenewal: The cluster is automatically renewed.
  • Normal: The cluster is manually renewed. Before the cluster expires, the system sends you a reminder by SMS message.
  • NotRenewal: The cluster is not renewed. Three days before the cluster expires, the system sends you a reminder by SMS message to remind you that the cluster is not renewed. However, the system does not send you a reminder when the cluster expires.
AutoRenewEnabled Boolean true

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

  • true: Auto-renewal is enabled.
  • false: Auto-renewal is disabled.
RegionId String cn-hangzhou

The region ID of the cluster.

Examples

Sample requests

http(s)://adb.aliyuncs.com/?Action=DescribeAutoRenewAttribute
&DBClusterIds=am-bp11q28kvl688****
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

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