Queries the auto renewal status of one or more ApsaraDB for Redis instances.

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 DescribeInstanceAutoRenewalAttribute

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

RegionId String Yes cn-hangzhou

The ID of the region where the instance is deployed.

ClientToken String No ETnLKlblzczshOTUbOCz****

The client token that is used to ensure the idempotency of requests. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.

DBInstanceId String No r-bp1zxszhcgatnx****

The ID of the instance.

Note By default, the system checks whether auto-renewal is enabled for all instances.
PageSize Integer No 30

The number of entries to return on each page. Valid values: 30, 50, and 100.

Note Default value: 30.
PageNumber Integer No 1

The number of the page to return. The value must be an integer greater than 0. Default value: 1.

Response parameters

Parameter Type Example Description
Items Array of Item

The auto-renewal status of instances.

Item
AutoRenew String true

Specifies whether to enable auto-renewal. Valid values:

  • true: enables auto-renewal.
  • false: disables auto-renewal.
DBInstanceId String r-bp1zxszhcgatnx****

The ID of the instance.

Duration Integer 1

The auto-renewal period. Unit: months.

RegionId String cn-shanghai

The ID of the region.

PageNumber Integer 1

The page number of the returned page.

PageRecordCount Integer 30

The number of returned entries on the current page.

TotalRecordCount Integer 1

The total number of returned entries.

RequestId String 2B17D708-1D6D-49F3-B6D7-478371DD****

The ID of the request.

Examples

Sample requests

https://r-kvstore.aliyuncs.com/Action=DescribeInstanceAutoRenewalAttribute
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<DescribeInstanceAutoRenewalAttributeResponse>
      <Items>
            <Item>
                  <Duration>1</Duration>
                  <RegionId>cn-shanghai</RegionId>
                  <DBInstanceId>r-bp1zxszhcgatnx****</DBInstanceId>
                  <AutoRenew>true</AutoRenew>
            </Item>
      </Items>
      <TotalRecordCount>1</TotalRecordCount>
      <PageNumber>1</PageNumber>
      <RequestId>2B17D708-1D6D-49F3-B6D7-478371DDDBE8</RequestId>
      <PageRecordCount>1</PageRecordCount>
</DescribeInstanceAutoRenewalAttributeResponse>

JSON format

{
    "Items": {
        "Item": [
            {
                "Duration": 1,
                "RegionId": "cn-shanghai",
                "DBInstanceId": "r-bp1zxszhcgatnx****",
                "AutoRenew": "true"
            }
        ]
    },
    "TotalRecordCount": 1,
    "PageNumber": 1,
    "RequestId": "2B17D708-1D6D-49F3-B6D7-478371DDDBE8",
    "PageRecordCount": 1
}

Error codes

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