You can call this operation to query the auto renewal status of one or more ApsaraDB for Redis instances.

Debugging

Alibaba Cloud provides OpenAPI Explorer to simplify API usage. You can use OpenAPI Explorer to search for APIs, call APIs, and dynamically generate SDK example code.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeInstanceAutoRenewalAttribute

The operation that you want to perform. Set this parameter to DescribeInstanceAutoRenewalAttribute.

RegionId String Yes cn-hangzhou

The ID of the region. Example: cn-hangzhou. You can call the DescribeRegions operation to query the latest region list.

AccessKeyId String No Lxxxxxxxxxxxxxxw

The AccessKey ID that Alibaba Cloud provides for you to access services.

ClientToken String No sampleclienttoken

The string generated by the client. This string is unique, case-sensitive, and can be 1 to 64 ASCII characters in length. The ClientToken parameter is optional. It ensures that making multiple identical requests has the same effect as making a single request. This prevents that more instances are created than expected.

DBInstanceId String No r-bp1xxxxxxxxxxxxx

The ID of the instance. You can specify this parameter to query the auto renewal status of a specified instance.

PageSize Integer No 30

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

PageNumber Integer No 1

The number of the page to return. It must be greater than 0 and cannot exceed the maximum value of the Integer type. Default value: 1.

Response parameters

Parameter Type Example Description
Items

The auto renewal status of instances.

└AutoRenew String true

Indicates whether auto renewal is enabled.

  • true
  • false
└DBInstanceId String r-bp1xxxxxxxxxxxxx

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 number of the page that was returned.

PageRecordCount Integer 30

The number of records that were returned on the current page.

TotalRecordCount Integer 1

The total number of records that were returned.

RequestId String 2B17D708-1D6D-49F3-B6D7-478371DDDBE8

The ID of the request.

Examples

Sample request


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

Sample success response

XML format

<DescribeInstanceAutoRenewalAttributeResponse>
  <Items>
    <Item>
      <Duration>1</Duration>
      <RegionId>cn-shanghai</RegionId>
      <DBInstanceId>r-j6cxxxxxxxxxxxxx</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":[
			{
				"DBInstanceId":"r-j6cxxxxxxxxxxxxx",
				"RegionId":"cn-shanghai",
				"Duration":1,
				"AutoRenew":"true"
			}
		]
	},
	"PageNumber":1,
	"TotalRecordCount":1,
	"RequestId":"2B17D708-1D6D-49F3-B6D7-478371DDDBE8",
	"PageRecordCount":1
}

Error codes

View error codes.