All Products
Search
Document Center

ApsaraDB RDS:TransformDBInstancePayType

Last Updated:May 22, 2024

Changes the billing method of an ApsaraDB RDS instance.

Operation description

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
rds:TransformDBInstancePayTypeWrite
  • DBInstance
    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 instance ID. You can call the DescribeDBInstances operation to query 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 11.
Note This parameter must be specified when PayType is set to Prepaid.
1
PayTypestringYes

The new 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
Note This 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

    The response parameters.

    DBInstanceIdstring

    The instance ID.

    rm-uf6wjk5xxxxxx
    RequestIdstring

    The ID of the request.

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

    The expiration time.

    Note If 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 order ID.

    205157600280623
    ChargeTypestring

    The payment type.

    • Valid value if the new billing method is pay-as-you-go: POSTPAY
    • Valid value if the new billing method is subscription: PREPAY
    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.-
    400AccountMoneyValidate.errorInsufficient funds available in the account.-
    400ContainForbiddenLabel.errorThere is a label that prohibits placing an order, and the order cannot be placed.-
    400Pay.InsufficientBalanceInsufficient available balance.Insufficient available balance.
    400CommodityServiceCalling.ExceptionFailed to call commodity service.Failed to call commodity service return.
    400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.Your account is abnormal, please contact customer service for details.
    400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.The module you purchased is not legal, please buy it again.
    400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.A package instance is not allowed to operate independently.
    400Price.PricingPlanResultNotFoundPricing plan price result not found.Pricing plan price result not found.
    400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
    400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.Your account available limit is less than 0, please recharge before trying to purchase.
    400RegionDissolvedEOMDear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
    400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.
    400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
    400Price.CommoditySysCommodity system call exception.Commodity system call exception.
    400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.There is a problem with the period you selected, please choose again.
    400pay.noCreditCardAccount not bound to credit card.-
    400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
    400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.Your basic information is not complete, please complete your basic information before operation.
    400System.SaleValidateFailedSales expression validation system error.A system error occurs when the sales expression is verified.
    400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
    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.
    403OrderStatus.UnPaidThe specified db instance has unpaid order.The instance has an unpaid order. Please pay first and try again.

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

    Change history

    Change timeSummary of changesOperation
    2024-05-14The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
    2024-05-11The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
    2024-03-11The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
    2023-09-08The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
    2023-05-04The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
    2022-09-01The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
    2021-10-26The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: AutoRenew