ModifyInstanceAutoRenewalAttribute - Enable or disable auto-renewal - ApsaraDB for MongoDB

Operation description

Before calling this operation, review the billing methods and pricing of ApsaraDB for MongoDB.

This operation applies only to subscription instances.

Note

When auto-renewal is enabled, payment is collected nine days before the instance expires. Ensure that your account has sufficient balance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dds:ModifyInstanceAutoRenewalAttribute

update

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance. Call DescribeDBInstanceAttribute to query this value.	cn-hangzhou
DBInstanceId	string	Yes	The ID of the instance.	dds-bp15da1923e3****
Duration	string	No	The auto-renewal period, in months. Valid values: 1 to 12. Note Valid only when AutoRenew is set to true.	1
AutoRenew	string	Yes	Specifies whether to enable auto-renewal. Valid values: true false Note When set to true, the Duration parameter is required.	true

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	EFD65226-08CC-4C4D-B6A4-CB3C382F67B0

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDbInstanceId.NotFound	Specified instance does not exist.	The instance ID does not exist.
400	InvalidDbInstanceIdInvalid	Instance dbInstanceId is invalid.
400	InstanceAutoRenewInvalid	Instance auto renewal is invalid.
400	InstanceChargeTypeInvalid	Instance charge type is invalid.	The instance charge type is invalid.
400	InvalidDuration.Invalid	Instance duration is invalid.
403	ClassicNetworkNotSupport	Classic network has not been supported, try to use VPC.	This operation does not support classic network instances. Use a VPC instance instead.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.