edit-icon download-icon


Last Updated: Apr 20, 2018


Query the automatic renewal settings of an instance.

This API supports only Subscription instances.

Rquest parameters

Parameter Type Required Example value Description
Action String Yes DescribeInstanceAutoRenewalAttribute

Set this parameter to DescribeInstanceAutoRenewalAttribute.

DBInstanceId String No rm-bp1842vmucoa5w874

Instance name.

PageNumber Integer No 1

Current page number.

PageSize Integer No 30

Number of records per page. Values: 30, 50, and 100. The default value is 30.

Response parameters

Parameter Type Example value Description
RequestId String 4E356DDF-6B83-45DB-99D5-4B1E8A0D286B

Request ID.

PageNumber Integer 1

Current page number.

TotalRecordCount Integer 200

Total number of records.

PageRecordCount Integer 10

Number of records per page.


List of returned items.

  └DBInstanceId String rm-ydjskx7yx30jsw

Instance ID, such as rm-ydjskx7yx30jsw.

  └RegionId String cn-hangzhou

Region ID.

  └Duration Integer 1

Renewal period. For example, the value 1 indicates one month.

  └Status String Normal

Instance status, such as Normal and Release.

  └AutoRenew String True

Whether automatic renewal is enabled.


Request example

  1. https://rds.aliyuncs.com/?Action=DescribeInstanceAutoRenewalAttribute
  2. &DBInstanceId=rm-bp1842vmucoa5w874
  3. &<Common request parameters>

Success response example

JSON format

  1. {
  2. "Items":{
  3. "AutoRenew":"True",
  4. "DBInstanceId":"rm-ydjskx7yx30jsw",
  5. "Duration":1,
  6. "RegionId":"cn-hangzhou",
  7. "Status":"Normal"
  8. },
  9. "PageNumber":1,
  10. "PageRecordCount":10,
  11. "RequestId":"A5409D02-D661-4BF3-8F3D-0A814D0574E7",
  12. "TotalRecordCount":200
  13. }

Error response example

JSON format

  1. {
  2. "Code":"UnsupportedOperation",
  3. "HostId":"rds.aliyuncs.com",
  4. "Message":"The specified action is not supported.",
  5. "RequestId":"7463B73D-35CC-4D19-A010-6B8D65D242EF"
  6. }

Error codes

API Error Center

Thank you! We've received your feedback.