All Products
Search
Document Center

ApsaraDB for ClickHouse:CreateDBInstance

Last Updated:Mar 11, 2024

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
ZoneIdstringNo

The zone ID. You can call the DescribeRegions operation to query the most recent zone list.

cn-hangzhou-h
DBClusterVersionstringYes

The kernel version. Valid values:

  • 21.8.10.19
  • 22.8.5.29
21.8.10.19
DBClusterCategorystringYes

The edition of the cluster. Valid values:

  • Basic: Single-replica Edition
  • HighAvailability: Double-replica Edition
Basic
DBClusterClassstringYes

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
DBNodeGroupCountstringYes

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
DBNodeStoragestringYes

The storage capacity of a single node. Valid values: 100 to 32000. Unit: GB.

Note This value is a multiple of 100.
100
DBClusterNetworkTypestringYes

The network type of the cluster. Only Virtual Private Cloud (VPC) is supported.

VPC
DBClusterDescriptionstringNo

The description of the cluster.

test
PayTypestringYes

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
PeriodstringNo

The unit of the subscription duration. This parameter is required when PayType is set to Prepaid.

Valid values:

  • Year
  • Month
Month
UsedTimestringNo

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
VPCIdstringYes

The VPC ID.

vpc-bp175iuvg8nxqraf2****
VSwitchIdstringYes

The vSwitch ID.

vsw-bp1gzt31twhlo0sa5****
ClientTokenstringNo

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
DbNodeStorageTypestringYes

The storage type of the cluster. Valid values:

  • CloudESSD_PL1: The cluster uses an enhanced SSD (ESSD) of performance level (PL) 1.
  • 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
EncryptionKeystringNo

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****
EncryptionTypestringNo

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
BackupSetIDstringNo

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
SourceDBClusterIdstringNo

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****
ResourceGroupIdstringNo

The ID of the resource group to which the cluster belongs.

rg-4690g37929****
ZoneIdBakstringNo

The secondary zone.

cn-hangzhou-k
VSwitchBakstringNo

The vSwitch in the secondary zone for the VPC.

vsw-bp1gzt31twhlo0sa5****
ZondIdBak2stringNo

Secondary zone 2.

cn-hangzhou-j
VSwitchBak2stringNo

The vSwitch in secondary zone 2 for the VPC.

vsw-bp1gzt31twhlo0sa5****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

F5178C10-1407-4987-9133-DE4DC9119F75
DBClusterIdstring

The cluster ID.

cc-bp1qx68m06981****
OrderIdstring

The order ID.

21137950671****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
500InternalErrorAn error occurred while processing your request.An error occurred while processing your request.
503ServiceUnavailableAn 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 timeSummary of changesOperation
2024-02-21The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 500
    delete Error Codes: 503
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: AutoRenew
2024-02-04The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 500
    delete Error Codes: 503
2023-12-08The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 500
    delete Error Codes: 503
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ZoneIdBak
    Added Input Parameters: VSwitchBak
    Added Input Parameters: ZondIdBak2
    Added Input Parameters: VSwitchBak2
2023-03-20The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 500
    delete Error Codes: 503
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ResourceGroupId
2021-11-04The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 500
    delete Error Codes: 503
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: BackupSetID
2021-11-04The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 500
    delete Error Codes: 503