Change cluster billing method with ModifyDBClusterPayType API - AnalyticDB - Alibaba Cloud - AnalyticDB

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

adb:ModifyDBClusterPayType

update

*DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
PayType	string	Yes	The billing method of the cluster. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.	Prepaid
Period	string	No	The subscription period unit. 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
UsedTime	string	No	The subscription duration of the cluster. Valid values when Period is set to Year: 1, 2, and 3 (integer) Valid values when Period is set to Month: 1 to 9 (integer) Note Required if PayType is set to Prepaid. Longer subscription periods are more cost-effective. For example, purchasing a cluster for one year is more cost-effective than purchasing the cluster for 10 or 11 months.	1
DbClusterId	string	Yes	The cluster ID.	am-bp11q28kvl688****
RegionId	string	No	The order ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
DBClusterId	string	The cluster ID.	am-bp11q28kvl688****
OrderId	string	The order ID.	2023532****
PayType	string	The billing method of the cluster. Valid values: Postpaid: pay-as-you-go Prepaid: subscription	Prepaid

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidPayType.Malformed	The specified parameter "PayType" is not changed.	The payment type has not been modified.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.