All Products
Document Center


Last Updated: Apr 19, 2018


This API enables or disables automatic renewal for an instance. If automatic renewal is enabled, instances are automatically renewed three days before the expiration date.

This API is applicable only to Subscription instances.

Request parameters

Parameter Type Required? Description
Action String Yes Set this parameter to ModifyInstanceAutoRenewalAttribute.
DBInstanceId String Yes Instance name.
Duration String No Renewal period. If AutoRenew is set to “True”, this parameter must be set. The value range is 1 to 12, indicating that the instance is renewed for 1 to 12 months.
AutoRenew String Yes Values:
True: Enable automatic renewal.
False: Disable automatic renewal.

Response parameters

Parameter Type Description
<Common response parameters> - For more information, see Common parameters.

View instances with automatic renewal

Request parameters

Parameter Type Required Description
Action String Yes Set this parameter to DescribeInstanceAutoRenewalAttribute.
RegionId String Yes Region name, for example, cn-hangzhou.
PageSize Number No Page size. The default value is 30.
PageNumber Number No Page number. The default value is 1.

Response parameters

Parameter Type Description
RequestId String Request ID.
PageNumber Integer Current page number.
TotalRecordCount Integer Total number of records.
PageRecordCount Integer Number of records per page.
Items List List of instances.

Item structure

Name Type Description
DBInstanceId String Instance ID, for example, rm-ydjskx7yx30jsw.
RegionId String Region name, for example, cn-hangzhou.
Duration Integer Renewal period. For example, if it is set to 1, the instance is automatically renewed for 1 month.
AutoRenew String Values:
True: Automatic renewal is enabled.
False: Automatic renewal is disabled.
Status String Resource status, such as Normal or Released.