ModifyDBInstanceClass - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Modifies the instance class of a cluster.

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

clickhouse:ModifyDBInstanceClass

update

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
DBInstanceId	string	Yes	The cluster ID.	cc-xxxxxxx
ScaleMin	integer	No	The minimum capacity for serverless autoscaling.	8
ScaleMax	integer	No	The maximum capacity for serverless autoscaling.	32
NodeScaleMax	integer	No	The maximum capacity per node for serverless autoscaling. Valid values: 4 to 32. The value must be greater than the value of NodeScaleMin.	4
NodeScaleMin	integer	No	The minimum capacity per node for serverless autoscaling. Valid values: 4 to 32.	32
NodeCount	integer	No	The number of nodes. Valid values: 2 to 16.	2
StorageQuota	integer	No	The pre-purchased storage capacity, in GB.	100
StorageType	string	No	The storage class.	OSS
ComputingGroupId	string	No	The compute group ID.

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	xxx-xxx-xxx
Data	object	The returned data.
TaskId	integer	The task ID.	10000****
ScaleMin	integer	The minimum capacity for serverless autoscaling.	2
ScaleMax	integer	The maximum capacity for serverless autoscaling.	32
DBInstanceID	integer	The cluster ID.	cc-xxxxxxx
DBInstanceName	string	The cluster name.	cc-xxxxxxx
ComputingGroupId	string

Examples

Success response

JSON format

{
  "RequestId": "xxx-xxx-xxx",
  "Data": {
    "TaskId": 0,
    "ScaleMin": 2,
    "ScaleMax": 32,
    "DBInstanceID": 0,
    "DBInstanceName": "cc-xxxxxxx\n",
    "ComputingGroupId": ""
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidSpecification	Specification parameter is not valid.	The specification parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.