CreateDBInstance - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Creates an ApsaraDB for ClickHouse cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
ZoneId	string	No	The zone ID. You can call the DescribeRegions operation to query the most recent zone list.	cn-hangzhou-h
DBClusterVersion	string	Yes	The kernel version. Valid values: 21.8.10.19 22.8.5.29	21.8.10.19
DBClusterCategory	string	Yes	The edition of the cluster. Valid values: Basic: Single-replica Edition HighAvailability: Double-replica Edition	Basic
DBClusterClass	string	Yes	The specifications of the cluster. Valid values when the cluster is of Single-replica Edition: S4: 4 CPU cores and 16 GB of memory S8: 8 CPU cores and 32 GB of memory S16: 16 CPU cores and 64 GB of memory S32: 32 CPU cores and 128 GB of memory S64: 64 CPU cores and 256 GB of memory S104: 104 CPU cores and 384 GB of memory Valid values when the cluster is of Double-replica Edition: C4: 4 CPU cores and 16 GB of memory C8: 8 CPU cores and 32 GB of memory C16: 16 CPU cores and 64 GB of memory C32: 32 CPU cores and 128 GB of memory C64: 64 CPU cores and 256 GB of memory C104: 104 CPU cores and 384 GB of memory	S8
DBNodeGroupCount	string	Yes	The number of nodes. Valid values when the cluster is of Single-replica Edition: 1 to 48. Valid values when the cluster is of Double-replica Edition: 1 to 24.	1
DBNodeStorage	string	Yes	The storage capacity of a single node. Valid values: 100 to 32000. Unit: GB. Note This value is a multiple of 100.	100
DBClusterNetworkType	string	Yes	The network type of the cluster. Only Virtual Private Cloud (VPC) is supported.	VPC
DBClusterDescription	string	No	The description of the cluster.	test
PayType	string	Yes	The billing method of the cluster. Valid values: Postpaid: The cluster uses the pay-as-you-go billing method. Prepaid: The cluster uses the subscription billing method.	Prepaid
Period	string	No	The unit of the subscription duration. This parameter is required when PayType is set to Prepaid. Valid values: Year Month	Month
UsedTime	string	No	The subscription duration of the subscription cluster. This parameter is required when PayType is set to Prepaid. Valid values: If Period is set to Year, the value of UsedTime must be an integer that ranges from 1 to 3. If Period is set to Month, the value of UsedTime must be an integer that ranges from 1 to 9.	1
VPCId	string	Yes	The VPC ID.	vpc-bp175iuvg8nxqraf2****
VSwitchId	string	Yes	The vSwitch ID.	vsw-bp1gzt31twhlo0sa5****
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. The value is a string and can be up to 64 ASCII characters in length.	AB
DbNodeStorageType	string	Yes	The storage type of the cluster. Valid values: CloudESSD: The cluster uses an enhanced SSD (ESSD) of performance level 1 (PL1). CloudESSD_PL2: The cluster uses an ESSD of PL2. CloudESSD_PL3: The cluster uses an ESSD of PL3. CloudEfficiency: The cluster uses an ultra disk.	CloudESSD_PL2
EncryptionKey	string	No	You must specify this parameter when EncryptionType is set to CloudDisk. The ID of the key that is used to encrypt data on disks. You can obtain the ID of the key from the Key Management Service (KMS) console. You can also create a key. Note If EncryptionType is empty, you do not need to specify this parameter.	0d2470df-da7b-4786-b981-9a164dae****
EncryptionType	string	No	The encryption type. Set the value to CloudDisk, which indicates that only disk encryption is supported. Note If this parameter is not specified, data is not encrypted.	CloudDisk
BackupSetID	string	No	The ID of the backup set. You can call the DescribeBackups operation to query the backup sets. Note If you want to restore the data of an ApsaraDB for ClickHouse cluster, this parameter is required.	b-12af23adsf
SourceDBClusterId	string	No	The ID of the source cluster. You can call the DescribeDBClusters operation to query backup set IDs. Note If you want to restore the data of an ApsaraDB for ClickHouse cluster, this parameter is required.	cc-bp1lxbo89u950****
ResourceGroupId	string	No	The ID of the resource group to which the cluster belongs.	rg-4690g37929****
ZoneIdBak	string	No	The secondary zone.	cn-hangzhou-k
VSwitchBak	string	No	The vSwitch in the secondary zone for the VPC.	vsw-bp1gzt31twhlo0sa5****
ZondIdBak2	string	No	Secondary zone 2.	cn-hangzhou-j
VSwitchBak2	string	No	The vSwitch in secondary zone 2 for the VPC.	vsw-bp1gzt31twhlo0sa5****
AutoRenew	boolean	No	Specifies whether to enable auto-renewal. Note This parameter is valid only if the value of PayType is set to Prepaid.	false

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	F5178C10-1407-4987-9133-DE4DC9119F75
DBClusterId	string	The cluster ID.	cc-bp1qx68m06981****
OrderId	string	The order ID.	21137950671****

Examples

Sample success responses

JSONformat

{
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75",
  "DBClusterId": "cc-bp1qx68m06981****",
  "OrderId": "21137950671****"
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	An error occurred while processing your request.	An error occurred while processing your request.
503	ServiceUnavailable	An error occurred while processing your request.	An error occurred while processing your request.

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

Change history

Change time	Summary of changes	Operation
2024-02-21	The Error code has changed. The request parameters of the API has changed	View Change Details
2024-02-04	The Error code has changed	View Change Details
2023-12-08	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-03-20	The Error code has changed. The request parameters of the API has changed	View Change Details
2021-11-04	The Error code has changed. The request parameters of the API has changed	View Change Details
2021-11-04	The Error code has changed	View Change Details