RenewDBInstance - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Operation description

Make sure that you fully understand the billing methods and pricing of ApsaraDB for MongoDB before you call this operation. For more information about the pricing of ApsaraDB for MongoDB, visit the pricing tab of the product buy page.

This operation is only applicable to instances that use the subscription billing method.

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 support 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:RenewDBInstance

update

*Instance

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

None

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.	ETnLKlblzczshOTUbOCzxxxxxxxxxx
DBInstanceId	string	Yes	The instance ID.	dds-bpxxxxxxxx
Period	integer	Yes	The subscription period of the instance. Unit: month. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, and 36.	1
AutoPay	boolean	No	Specifies whether to enable automatic payment. Valid values: true: enables automatic payment. Make sure that you have sufficient balance within your account. false: disables automatic payment. You must perform the following operations to pay for the instance: Log on to the ApsaraDB for MongoDB console. In the upper-right corner, click Expenses and select User Center from the drop-down list. The User Center page appears. In the left-side navigation pane, choose Order Management > Renew. On the Renewal tab, find the bill that you want to pay and then click Renew in the Actions column. Default value: true.	true
BusinessInfo	string	No	The business information.	{“ActivityId":"000000000"}
CouponNo	string	No	Specifies whether to use coupons. Default value: null. Valid values: default or null: uses coupons. youhuiquan_promotion_option_id_for_blank: does not use coupons.	1111111111111111
AutoRenew	boolean	No	Specifies whether to enable auto-renewal. Valid values: true false Default value: false.	true

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	B118EF45-9633-4EE3-8405-42ED4373721B
OrderId	string	The ID of the order.	203317xxxxxxxx

Examples

Success response

JSON format

{
  "RequestId": "B118EF45-9633-4EE3-8405-42ED4373721B",
  "OrderId": "203317xxxxxxxx"
}

Error codes

HTTP status code	Error code	Error message	Description
400	TokenServiceError	Request token is duplicated.
403	ClassicNetworkNotSupport	Classic network has not been supported, try to use VPC.	The current operation does not support classic network instances, please use VPC network.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.