All Products
Document Center

ApsaraDB for MongoDB:ModifyInstanceAutoRenewalAttribute

Last Updated:Jan 17, 2023

Enables or disables auto-renewal for an ApsaraDB for MongoDB instance.

Operation Description

Before you call this operation, make sure that you fully understand the billing methods and pricing.

This operation is applicable to subscription instances.

Note When auto-renewal is enabled, your payment will be collected nine days before the expiration date of ApsaraDB for MongoDB. Ensure that your account has sufficient balance.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
  • Condition keyword: refers to the condition keyword defined by the cloud product itself.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operate access level Resource type conditional keyword Association operation
dds:ModifyInstanceAutoRenewalAttribute WRITE
  • MongoDB

Request parameters

Parameter Type Required Description Example
RegionId string Yes

The region ID of the instance. You can call the DescribeDBInstanceAttribute operation to query the region ID of the instance.

DBInstanceId string Yes

The ID of the instance.

Duration string No

The auto-renewal period. Valid values: 1 to 12. Unit: month.

Note This parameter is valid only when AutoRenew is set to true.
AutoRenew string Yes

Specifies whether to enable auto-renewal. Valid values:

  • true
  • false
Note If this parameter is set to true, you must set the Duration parameter.

Response parameters

Parameter Type Description Example
RequestId string

The ID of the request.



Normal return example


  "RequestId": "EFD65226-08CC-4C4D-B6A4-CB3C382F67B0"

Error codes

Http code Error code Error message
400 InvalidDbInstanceId.NotFound Specified instance does not exist.
400 InvalidDbInstanceIdInvalid Instance dbInstanceId is invalid.
400 InstanceAutoRenewInvalid Instance auto renewal is invalid.
400 InvalidDuation.Invalid Instance duation is invalid.
400 InstanceChargeTypeInvalid Instance charge type is invalid.

For a list of error codes, visit the API error center.