All Products
Search
Document Center

AnalyticDB:ModifyDBClusterPayType

Last Updated:Aug 30, 2024

Changes the billing method of an AnalyticDB for MySQL cluster.

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
adb:ModifyDBClusterPayTypeupdate
  • DBCluster
    acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PayTypestringYes

The billing method. Valid values:

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

The subscription type of the subscription cluster. Valid values:

  • Year: subscription on a yearly basis.
  • Month: subscription on a monthly basis.
Note This parameter must be specified when PayType is set to Prepaid.
Year
UsedTimestringNo

The subscription duration of the subscription cluster.

  • Valid values when Period is set to Year: 1, 2, 3, and 5 (integer).
  • Valid values when Period is set to Month: 1 to 11 (integer).
Note
  • This parameter must be specified when PayType is set to Prepaid.

  • Longer subscription durations offer more savings. Purchasing a cluster for one year is more cost-effective than purchasing the cluster for 10 or 11 months.

1
DbClusterIdstringYes

The cluster ID.

am-bp11q28kvl688****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

1AD222E9-E606-4A42-BF6D-8A4442913CEF
DBClusterIdstring

The cluster ID.

am-bp11q28kvl688****
OrderIdstring

The order ID.

2023532****
PayTypestring

The billing method. Valid values:

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

Examples

Sample success responses

JSONformat

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "DBClusterId": "am-bp11q28kvl688****",
  "OrderId": "2023532****",
  "PayType": "Prepaid"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidPayType.MalformedThe specified parameter "PayType" is not changed.The payment type has not been modified.

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

Change history

Change timeSummary of changesOperation
2024-07-24The Error code has changed. The request parameters of the API has changedView Change Details
2022-02-22Add OperationView Change Details