All Products
Search

This Product

    ApsaraDB for MongoDB:TransformToPrePaid

    Document Center

    ApsaraDB for MongoDB:TransformToPrePaid

    Last Updated:Sep 03, 2024

    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.

    Debugging

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

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    dds:TransformToPrePaidupdate
    • Instance
      acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceIdstringYes

    The ID of the instance.

    		dds-bp1366caac83****
    PeriodlongYes

    The subscription duration of the instance. Unit: months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, and 36.

    		1
    AutoPaybooleanNo

    Specifies whether to enable automatic payment. Valid values:

    Note Default value: true.
    		true
    BusinessInfostringNo

    The business information. This is an additional parameter.

    		{“ActivityId":"000000000"}
    AutoRenewstringNo

    Specifies whether to enable auto-renewal for the instance. Valid values:

    • true
    • false
    Note Default value: false.
    		true
    CouponNostringNo

    The coupon code. Default value: youhuiquan_promotion_option_id_for_blank.

    		youhuiquan_promotion_option_id_for_blank

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		2F42BB4E-461F-5B55-A37C-53B1141C****
    OrderIdstring

    The ID of the order.

    		21022019252****

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400MissingParameterPeriod is mandatory for this action.-
    400InvalidParamPeriod is invalid-
    400ResourceNotAvailableResource you requested is not available for finance user.-
    400InsufficientBalanceYour 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.
    403AlreadyPrePaidThis instance is already prepaidThe instance already uses the subscription billing method.
    403RealNameAuthenticationErrorYour 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 timeSummary of changesOperation
    No change history