ModifyDBCluster - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Upgrades or downgrades an ApsaraDB for ClickHouse cluster.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
clickhouse:ModifyDBCluster	update	DBCluster acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	No	The cluster ID.	cc-bp19lo45sy98x****
DBNodeGroupCount	string	Yes	The number of nodes in the cluster. If the cluster is of Single-replica Edition, the value must be an integer that ranges from 1 to 48. If the cluster is of Double-replica Edition, the value must be an integer that ranges from 1 to 24.	1
DBNodeStorage	string	Yes	The storage capacity of a single node of the cluster. Unit: GB. Valid values: 100 to 32000. Note This value is a multiple of 100.	100
DBClusterClass	string	Yes	The specifications of the cluster. Valid values when the cluster is of Single-replica Edition: S4-NEW S8 S16 S32 S64 S104 Valid values when the cluster is of Double-replica Edition: C4-NEW C8 C16 C32 C64 C104	S4-NEW
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object
DBCluster	object	The information about the cluster.
dbClusterId	string	The cluster ID.	cc-bp19lo45sy98x****
orderId	string	The order ID.	21417210003****
RequestId	string	The request ID.	BA30A000-3A4D-5B97-9420-E5D0D49F7016

Examples

Sample success responses

JSONformat

{
  "DBCluster": {
    "dbClusterId": "cc-bp19lo45sy98x****",
    "orderId": "21417210003****"
  },
  "RequestId": "BA30A000-3A4D-5B97-9420-E5D0D49F7016"
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The DBClusterId provided does not exist in our records.

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

Change history

Change time	Summary of changes	Operation
2024-09-03	The Error code has changed. The request parameters of the API has changed	View Change Details
2024-02-04	The Error code has changed. The request parameters of the API has changed	View Change Details