TransformToPrePaid - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Operation description

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

A subscription instance cannot be changed to a pay-as-you-go instance. To avoid wasting resources, proceed with caution.

Before you call this API operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:

The instance is in the running state.
The billing method of the instance is pay-as-you-go.
The instance has no unpaid subscription orders.
The instance type is available for purchase. For more information about unavailable instance types, see Instance types.

Note

To change the billing method of an instance whose instance type is no longer available to subscription, call the ModifyDBInstanceSpec or ModifyNodeSpec operation to first change the instance type.

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:TransformToPrePaid

update

*Instance

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

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	dds-bp1366caac83****
Period	integer	Yes	The subscription duration of the instance. Unit: months. 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. false: disables automatic payment. For more information, see Renew an ApsaraDB for MongoDB subscription instance. Note Default value: true.	true
BusinessInfo	string	No	The business information. This is an additional parameter.	{“ActivityId":"000000000"}
AutoRenew	string	No	Specifies whether to enable auto-renewal for the instance. Valid values: true false Note Default value: false.	true
CouponNo	string	No	The coupon code. Default value: `youhuiquan_promotion_option_id_for_blank`.	default

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	2F42BB4E-461F-5B55-A37C-53B1141C****
OrderId	string	The ID of the order.	21022019252****

Examples

Success response

JSON format

{
  "RequestId": "2F42BB4E-461F-5B55-A37C-53B1141C****",
  "OrderId": "21022019252****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	Period is mandatory for this action.
400	InvalidParam	Period is invalid
400	ResourceNotAvailable	Resource you requested is not available for finance user.
400	InsufficientBalance	Your account does not have enough balance.
403	AlreadyPrePaid	This instance is already prepaid	The instance already uses the subscription billing method.
403	RealNameAuthenticationError	Your account has not passed the real-name authentication yet.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.