TransformInstanceChargeType - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Changes the billing method of an instance from pay-as-you-go to subscription or from subscription to pay-as-you-go.

Operation description

Before you call this operation, make sure that you understand the billing methods and pricing of ApsaraDB for MongoDB

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.
Your instance has no unpaid billing method change 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 purchase, call the ModifyDBInstanceSpec or ModifyNodeSpec operation to change the instance type first.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

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 Key: the condition key that is defined by the cloud service.
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.

Operation	Access level	Resource type	Condition key	Associated operation
dds:TransformInstanceChargeType	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	dds-2ze55b3ec56c****
Period	long	No	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 false 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. Valid values: true false Note Default value: false.	false
CouponNo	string	No	The coupon code. Default value: `youhuiquan_promotion_option_id_for_blank`.	youhuiquan_promotion_option_id_for_blank
ChargeType	string	Yes	The billing method of the instance. Valid values: PrePaid: subscription. PostPaid: pay-as-you-go.	PrePaid

Response parameters

Parameter	Type	Description	Example
	object	Response
RequestId	string	The request ID.	D8F1D721-6439-4257-A89C-F1E8E9C9****
OrderId	string	The order ID.	21084641369****

Examples

Sample success responses

JSONformat

{
  "RequestId": "D8F1D721-6439-4257-A89C-F1E8E9C9****",
  "OrderId": "21084641369****"
}

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.	The payment failed. Please add another payment method. You can also top up or add funds to your account.
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.	Real-name verification has not been completed for the Alibaba Cloud account. Complete real-name verification and try again.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-08-26	The Error code has changed	View Change Details
2023-08-25	The Error code has changed. The request parameters of the API has changed	View Change Details