All Products
Search

This Product

    ApsaraDB RDS:TransformDBInstancePayType

    Document Center

    ApsaraDB RDS:TransformDBInstancePayType

    Last Updated:Jun 01, 2023

    Changes the billing method of an instance.

    Operation Description

    Note

    • If you change the billing method of an instance from subscription to pay-as-you-go, a refund may be provided. The refund amount is equal to the remaining subscription fee deducted by an amount of service fee. For more information, see Switch an ApsaraDB RDS for MySQL instance from subscription to pay-as-you-go.

    • If the balance of your Alibaba Cloud account is insufficient, you cannot change the billing method of an instance from pay-as-you-go to subscription.

    • This operation is not supported for instances whose specification change orders are not completed.

    • This operation is not supported for instances that are created in dedicated clusters.

    ApsaraDB RDS supports the following two billing methods:

    • Subscription: A subscription instance is an instance for which you pay an upfront fee. For long-term use, the subscription billing method is more cost-effective than the pay-as-you-go billing method. You are offered lower prices for longer subscription durations.
    • Pay-as-you-go: A pay-as-you-go instance is an instance for which you are charged per hour based on your resource usage. The hourly fee is calculated based on the instance type that you specify in the purchase order and is deducted from the balance of your Alibaba Cloud account. We recommend that you select the pay-as-you-go billing method for short-term use. If you no longer need your pay-as-you-go instance, you can release the instance to reduce costs.

    For more information about the billing methods, see Pricing, billable items, and billing methods.

    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
    rds:TransformDBInstancePayTypeWRITE
    • RDS
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, 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
    DBInstanceIdstringYes

    The ID of the instance.

    		rm-uf6wjk5xxxxxx
    UsedTimeintegerNo

    The subscription duration of the instance. Valid values:

    • If you set Period to Year, the value of UsedTime ranges from 1 to 5.
    • If you set Period to Month, the value of UsedTime ranges from 1 to 9.
    NoteThis parameter must be specified if you set PayType to Prepaid.
    		1
    PayTypestringYes

    The billing method of the instance. Valid values:

    • Postpaid: pay-as-you-go
    • Prepaid: subscription
    		Prepaid
    PeriodstringNo

    The renewal cycle of the instance. Valid values:

    • Year
    • Month
    NoteThis parameter must be specified if you set PayType to Prepaid.
    		Month
    BusinessInfostringNo

    The additional business information about the instance.

    		None
    AutoRenewstringNo

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

    • true
    • false
    Note

    • This parameter is valid only when you change the billing method from pay-as-you-go to subscription.

    • All strings except true are considered false.

    		true

    Response parameters

    ParameterTypeDescriptionExample
    object
    DBInstanceIdstring

    The ID of the instance.

    		rm-uf6wjk5xxxxxx
    RequestIdstring

    The ID of the request.

    		5E6E09DE-5B12-4BFF-A55E-1C86EDE06D9A
    ExpiredTimestring

    The expiration time.

    NoteIf you call this operation to change the billing method of an instance from subscription to pay-as-you-go, this parameter is not returned.
    		2020-04-20T10:00:00Z
    OrderIdlong

    The ID of the order.

    		205157600280623
    ChargeTypestring

    The billing method.

    		Prepaid

    Examples

    Sample success responses

    JSONformat

    {
  "DBInstanceId": "rm-uf6wjk5xxxxxx",
  "RequestId": "5E6E09DE-5B12-4BFF-A55E-1C86EDE06D9A",
  "ExpiredTime": "2020-04-20T10:00:00Z",
  "OrderId": 205157600280623,
  "ChargeType": "Prepaid"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidDBInstanceName.NotFoundThe specified DB instance name does not exist.The instance name does not exist.
    400InvalidInstanceUseType.NotSupportSpecified instanceUseType does not support in RDS.The operation failed. The role that is specified by the instanceUseType parameter is not supported for the RDS instance.
    400InvalidOrderCharge.NotSupportThe specified order charge does not support in RDS.The operation failed. ApsaraDB RDS supports two billing methods: subscription (Prepaid) and pay-as-you-go (Postpaid). Specify a valid billing method by using the PayType parameter.
    400InvalidOrderTask.NotSupportThe Current InstanceId exist Order Task in RDS.Uncompleted order tasks are found in the RDS instance. Please try again later.
    400IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.The operation failed. The RDS instance is not in a ready state.
    400IncompleteAccountInfoYour information is incomplete. Complete your information before the operation.The operation failed. Items that are marked with an asterisk (*) in the account information must be specified. Make sure that you specify these items on the Basic Information page in Account Center.
    400IncompleteTaxInfoYour tax information is incomplete. Complete your information before the operation.The operation failed. Your tax information is incomplete. Complete your tax information.
    400InvalidPaymentMethod.IncompleteNo payment method is specified for your account. We recommend that you add a payment method.No valid payment method is specified for your Alibaba Cloud account. Add a valid payment method.
    400InvalidPaymentMethod.MissingYour payment method is incomplete. We recommend that you add a payment method.No valid payment method is specified within your Alibaba Cloud account. Add a valid payment method.
    400InsuffcientBalanceOrBankAccountAdd a payment method or add funds to the prepayment balance. Get started by creating an instance.No valid payment method is specified within your Alibaba Cloud account. Add a valid payment method or add funds to your Alibaba Cloud account.
    400InvalidPaymentMethod.NoAccessNo payment method is specified for your account. Please contact your Customer Manager or open a ticket.-
    400InvalidPaymentMethod.MissingNo payment method is specified for your account. We recommend that you add a payment method.No valid payment method is specified for your Alibaba Cloud account. Add a valid payment method.
    400InvalidPaymentMethod.InsufficientBalanceNo payment method is specified for your account. We recommend that you add a payment method or add funds to the prepayment balance.-
    400OrderTaskAlreadyExistsOrder task already exists.The specified order task already exists.
    400InvalidOldInstanceType.NotSupportSpecified oldInstanceType does not support in RDS.This operation is not supported for the database engine version of the current instance.
    400OperationDenied.TimeLimitThe interval between the two conversion operations must be greater than 15 minutes.The operation failed. The time interval between two operations that are performed to convert the payment type must be greater than 15 minutes.
    400InvalidDBInstanceId.MalformedThe specified parameter DBInstanceId is not valid.The instance ID is invalid. Check the instance ID.
    400InvalidPayType.MalformedThe specified parameter PayType is not valid.-
    400InvalidResource.FormatThe specified parameter Resource is not valid.The resource ID is invalid.
    400InvalidPayType.FormatThe specified parameter PayType is not valid.The payment type is invalid.
    400InvalidUsedTime.FormatThe specified parameter UsedTime is not valid.UsedTime is not defined.
    400InvalidPeriod.FormatThe specified parameter Period is not valid.-
    400InvalidPeriodOrUsedTime.FormatThe specified parameter Period and UsedTime are not valid.-
    400InvalidDiscountCoupon.MalformedThe specified discount coupon is not valid.-
    400InsufficientQuota.NoEnoughYour current quota is insufficient. Please contact your channel partner to increase your quota.The quota is insufficient. Contact your channel partner to request a quota increase.
    400SYSTEM.ILLEGALARGUMENTThe current instance does not have a valid configuration when change the payType from Prepaid to Postpaid.-
    403OperationDenied.LockModeThe operation is not permitted when the instance locked.The operation failed. The RDS instance is locked possibly because the balance within your Alibaba Cloud account is insufficient. Top up or add funds to your Alibaba Cloud account to unlock the RDS instance.

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

    Change history

    Change timeSummary of changesOperation
    2023-05-04The error codes of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change
      delete Error Codes: 403
    2022-09-01The error codes of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change
      delete Error Codes: 403
    2021-10-26The error codes of the API operation change.,The input parameters of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      delete Error Codes: 403
    Input ParametersThe input parameters of the API operation change.
      Added Input Parameters: AutoRenew