ModifyDBCluster - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

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:ModifyDBCluster

update

*DBCluster

acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	No	The cluster ID.	cc-bp19lo45sy98x****
DBNodeGroupCount	string	Yes	The number of nodes. For single-replica editions, the valid values are integers from 1 to 48. For dual-replica editions, the valid values are integers from 1 to 24.	1
DBNodeStorage	string	Yes	The storage space of a single node. Unit: GB. Valid values: 100 to 32000. Note The step size is 100 GB.	100
DBClusterClass	string	Yes	The cluster specifications. For single-replica editions, valid values are: S8 S16 S32 S64 S104 For dual-replica editions, valid values are: C8 C16 C32 C64 C104	S8
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
DbNodeStorageType	string	No	The storage class. Valid values: CloudESSD: ESSD PL1 disk. CloudESSD_PL2: ESSD PL2 disk. CloudESSD_PL3: ESSD PL3 disk. CloudEfficiency: ultra disk. CloudSSD: standard SSD.	CloudESSD
DisableWriteWindows	string	No	The write-inaccessible window. Separate the start time and the end time with a comma. Use the ISO 8601 format for the time.	2024-07-09T20:00:00+08:00,2024-07-09T21:00:00+08:00

Response elements

Element	Type	Description	Example
	object
DBCluster	object	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

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.