All Products
Search
Document Center

DescribeAutoRenewAttribute

Last Updated: Aug 05, 2020

Queries the auto-renewal attribute of AnalyticDB for MySQL clusters billed in the subscription mode.

Request parameters

ParameterTypeRequiredExampleDescription
ActionStringYesDescribeAutoRenewAttributeThe operation that you want to perform. Set the value to DescribeAutoRenewAttribute.

RegionIdStringYescn-hangzhouThe ID of the region where the target clusters reside.
DBClusterIdsStringNoam-bp1xxxxxxxx47The ID of the cluster whose auto-renewal attribute is to be queried.

Separate multiple cluster IDs with commas (,).

PageSizeIntegerNo30The number of entries to return on each page. Valid values:
  • 30
  • 50
  • 100
Default value: 30
PageNumberIntegerNo1The number of the page to return. Valid values: any positive integer

Default value: 1

Response parameters

ParameterTypeExampleDescription
RequestIdString1AD222E9-E606-4A42-BF6D-8A4442913CEFThe ID of the request.
PageNumberInteger1The page number of the page returned.
TotalRecordCountInteger20The total number of entries returned.
PageRecordCountInteger2The total number of pages returned.
ItemsList<AutoRenewAttribute>-The renewal information about clusters.

AutoRenewAttribute

ParameterTypeExampleDescription
DBClusterIdStringam-bp1xxxxxxxx47The ID of a cluster.
RegionIdStringcn-hangzhouThe ID of the region where the cluster resides.
AutoRenewEnabledBooleantrueIndicates whether the auto-renewal feature was enabled. Valid values:
  • true: enabled
  • false: disabled
DurationInteger1The renewal period of the cluster.
PeriodUnitStringYearThe unit of the renewal period. Valid values:
  • Year
  • Month
RenewalStatusStringAutoRenewalThe renewal type 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 a reminder three days before the cluster expires to remind you that the cluster is not renewed.

Examples

Sample requests

  1. https://adb.aliyuncs.com/?Action=DescribeAutoRenewAttribute
  2. &RegionId=cn-hangzhou
  3. &DBClusterId=am-xxxxxxxxxxxxxxxx
  4. &<Common request parameters>

Sample success responses

XML format

  1. <DescribeAutoRenewAttributeResponse>
  2. <Items>
  3. <AutoRenewAttribute>
  4. <RenewalStatus>Normal</RenewalStatus>
  5. <Duration>1</Duration>
  6. <RegionId>cn-hangzhou</RegionId>
  7. <AutoRenewEnabled>true</AutoRenewEnabled>
  8. <PeriodUnit>Month</PeriodUnit>
  9. <DBClusterId>am-xxxxxxxxxxxxxxxx</DBClusterId>
  10. </AutoRenewAttribute>
  11. </Items>
  12. <TotalRecordCount>1</TotalRecordCount>
  13. <PageNumber>1</PageNumber>
  14. <RequestId>8ABD1FF2-85B1-4D03-8C99-FB603B8AF82D</RequestId>
  15. <PageRecordCount>1</PageRecordCount>
  16. </DescribeAutoRenewAttributeResponse>

JSON format

  1. {
  2. "Items": {
  3. "AutoRenewAttribute": [
  4. {
  5. "RenewalStatus": "AutoRenewal",
  6. "Duration": 1,
  7. "RegionId": "cn-hangzhou",
  8. "AutoRenewEnabled": true,
  9. "PeriodUnit": "Month",
  10. "DBClusterId": "am-xxxxxxxxxxxxxxxx"
  11. }
  12. ]
  13. },
  14. "TotalRecordCount": 1,
  15. "PageNumber": 1,
  16. "RequestId": "8ABD1FF2-85B1-4D03-8C99-FB603B8AF82D",
  17. "PageRecordCount": 1
  18. }