All Products
Search

This Product

    ApsaraDB for MongoDB:TransformToPrePaid

    Document Center

    ApsaraDB for MongoDB:TransformToPrePaid

    Last Updated:Jan 17, 2023

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

    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.

    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:TransformToPrePaid WRITE
    • MongoDB
      acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
      without
    		without

    Request parameters

    Parameter Type Required Description Example
    InstanceId string Yes

    The ID of the instance.

    		 dds-bp1366caac83****
    Period long 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:

    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.

    		 youhuiquan_promotion_option_id_for_blank

    Response parameters

    Parameter Type Description Example
    object
    RequestId string

    The ID of the request.

    		 2F42BB4E-461F-5B55-A37C-53B1141C****
    OrderId string

    The ID of the order.

    		 21022019252****

    Example

    Normal return example

    JSONFormat

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

    Error codes

    Http code Error code Error message
    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
    403 RealNameAuthenticationError Your account has not passed the real-name authentication yet.

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