DescribeAutoRenewAttribute - API Reference| Alibaba Cloud Documentation Center

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

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 ID of the region where the target clusters reside.
DBClusterIds	String	No	am-bp1xxxxxxxx47	The ID of the cluster whose auto-renewal attribute is to be queried. Separate 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 number of the page to return. Valid values: any positive integer Default value: 1

Response parameters

Parameter	Type	Example	Description
RequestId	String	1AD222E9-E606-4A42-BF6D-8A4442913CEF	The ID of the request.
PageNumber	Integer	1	The page number of the page returned.
TotalRecordCount	Integer	20	The total number of entries returned.
PageRecordCount	Integer	2	The total number of pages returned.
Items	List<AutoRenewAttribute>	-	The renewal information about clusters.

AutoRenewAttribute

Parameter	Type	Example	Description
DBClusterId	String	am-bp1xxxxxxxx47	The ID of a cluster.
RegionId	String	cn-hangzhou	The ID of the region where the cluster resides.
AutoRenewEnabled	Boolean	true	Indicates whether the auto-renewal feature was enabled. Valid values: true: enabled false: disabled
Duration	Integer	1	The renewal period of the cluster.
PeriodUnit	String	Year	The unit of the renewal period. Valid values: Year Month
RenewalStatus	String	AutoRenewal	The 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

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

Sample success responses

XML format

<DescribeAutoRenewAttributeResponse>  
    <Items>
        <AutoRenewAttribute>
            <RenewalStatus>Normal</RenewalStatus>
            <Duration>1</Duration>
            <RegionId>cn-hangzhou</RegionId>
            <AutoRenewEnabled>true</AutoRenewEnabled>
            <PeriodUnit>Month</PeriodUnit>
            <DBClusterId>am-xxxxxxxxxxxxxxxx</DBClusterId>
        </AutoRenewAttribute>
    </Items>
    <TotalRecordCount>1</TotalRecordCount>
    <PageNumber>1</PageNumber>
    <RequestId>8ABD1FF2-85B1-4D03-8C99-FB603B8AF82D</RequestId>
    <PageRecordCount>1</PageRecordCount>
</DescribeAutoRenewAttributeResponse>

JSON format

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