All Products
Search

This Product

    ApsaraDB for ClickHouse:CreateDBInstance

    Document Center

    ApsaraDB for ClickHouse:CreateDBInstance

    Last Updated:Dec 18, 2025

    Creates an ApsaraDB for ClickHouse cluster.

    Operation description

    Make sure you understand the billing methods and pricing of ApsaraDB for ClickHouse before calling this operation.

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

    create

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID. Call the DescribeRegions operation to query the available region IDs.

    cn-hangzhou
    ZoneId

    string

    No

    The zone ID. Call the DescribeRegions operation to query the available zone IDs.

    cn-hangzhou-h
    DBClusterVersion

    string

    Yes

    The engine version. Valid values:

    • 21.8.10.19

    • 22.8.5.29

    Valid values:

    • 22.8.5.29 :

      22.8.5.29

    • 21.8.10.19 :

      21.8.10.19

    22.8.5.29
    DBClusterCategory

    string

    Yes

    The edition of the cluster. Valid values:

    • Basic: single-replica edition.

    • HighAvailability: dual-replica edition.

    Valid values:

    • Basic :

      Basic

    • HighAvailability :

      HighAvailability

    Basic
    DBClusterClass

    string

    Yes

    The instance type of the cluster.

    • For single-replica clusters, valid values:

      • LS20: Large Storage, 20 cores, 88 GB memory.

      • LS40: Large Storage, 40 cores, 176 GB memory.

      • LS80: Large Storage, 80 cores, 352 GB memory.

      • S8: Standard, 8 cores, 32 GB memory.

      • S16: Standard, 16 cores, 64 GB memory.

      • S32: Standard, 32 cores, 128 GB memory.

      • S64: Standard, 64 cores, 256 GB memory.

      • S80: Standard, 80 cores, 384 GB memory.

      • S104: Standard, 104 cores, 384 GB memory.

    • For dual-replica clusters, valid values:

      • LC20: Large Storage, 20 cores, 88 GB memory.

      • LC40: Large Storage, 40 cores, 176 GB memory.

      • LC80: Large Storage, 80 cores, 352 GB memory.

      • C8: Standard, 8 cores, 32 GB memory.

      • C16: Standard, 16 cores, 64 GB memory.

      • C32: Standard, 32 cores, 128 GB memory.

      • C64: Standard, 64 cores, 256 GB memory.

      • C80: Standard, 80 cores, 384 GB memory.

      • C104: Standard, 104 cores, 384 GB memory.

    • Single-replica edition:

      • S8: 8 cores, 32 GB.

      • S16: 16 cores, 64 GB.

      • S32: 32 cores, 128 GB.

      • S64: 64 cores, 256 GB.

      • S104: 104 cores, 384 GB.

    • Dual-replica edition:

      • C8: 8 cores, 32 GB.

      • C16: 16 cores, 64 GB.

      • C32: 32 cores, 128 GB.

      • C64: 64 cores, 256 GB.

      • C104: 104 cores, 384 GB.

    S8
    DBNodeGroupCount

    string

    Yes

    The number of nodes.

    • For single-replica clusters, the value ranges from 1 to 48.

    • For dual-replica clusters, the value ranges from 1 to 24.

    1
    DBNodeStorage

    string

    Yes

    The storage capacity of a single node, in GB. Valid values: 100 to 32,000.

    Note

    The value must be a multiple of 100.

    100
    DBClusterNetworkType

    string

    Yes

    The network type of the cluster. Only VPC is supported.

    VPC
    DBClusterDescription

    string

    No

    The description of the cluster.

    test
    PayType

    string

    Yes

    The billing method. Valid values:

    • Postpaid: pay-as-you-go.

    • Prepaid: subscription.

    Valid values:

    • Prepaid :

      Prepaid

    • Postpaid :

      Postpaid

    Prepaid
    Period

    string

    No

    The unit of the subscription duration. Valid values:

    Important This parameter is required only when PayType is set to Prepaid.

    • Year

    • Month

    Month
    UsedTime

    string

    No

    The subscription duration.

    Important This parameter is required only when PayType is set to Prepaid.

    • If Period is set to Year, valid values are 1, 2, and 3.

    • If Period is set to Month, valid values are integers from 1 to 9.

    1
    VPCId

    string

    Yes

    The ID of the VPC.

    vpc-bp175iuvg8nxqraf2****
    VSwitchId

    string

    Yes

    The ID of the vSwitch.

    vsw-bp1gzt31twhlo0sa5****
    ClientToken

    string

    No

    A client token that is used to ensure the idempotence of the request. The value must be a string of up to 64 ASCII characters.

    AB
    DbNodeStorageType

    string

    Yes

    The storage type. Valid values:

    • CloudESSD: ESSD PL1 disk.

    • CloudESSD_PL2: ESSD PL2 disk.

    • CloudESSD_PL3: ESSD PL3 disk.

    • CloudEfficiency: ultra disk.

    CloudESSD_PL2
    EncryptionKey

    string

    No

    This parameter is required if EncryptionType is set to CloudDisk.

    The ID of the key for disk encryption. You can view the key ID in the Key Management Service (KMS) console. You can also create a key.

    Note

    If you do not specify an encryption type, this parameter is not required.

    0d2470df-da7b-4786-b981-9a164dae****
    EncryptionType

    string

    No

    The encryption type. Only disk encryption is supported. Set the value to CloudDisk.

    Note

    If you do not specify this parameter, data is not encrypted.

    CloudDisk
    BackupSetID

    string

    No

    The backup set ID. Call the DescribeBackups operation to query backup set IDs.

    Note

    This parameter is required to create a cluster by restoring data from a backup.

    b-12af23adsf
    SourceDBClusterId

    string

    No

    The ID of the source cluster. Call the DescribeDBClusters operation to query cluster IDs.

    Note

    This parameter is required to create a cluster by restoring data from a backup.

    cc-bp1lxbo89u950****
    ResourceGroupId

    string

    No

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

    rg-4690g37929****
    ZoneIdBak

    string

    No

    The ID of the secondary zone.

    cn-hangzhou-k
    VSwitchBak

    string

    No

    The ID of the secondary vSwitch.

    vsw-bp1gzt31twhlo0sa5****
    ZondIdBak2

    string

    No

    The ID of the secondary zone 2.

    cn-hangzhou-j
    VSwitchBak2

    string

    No

    The ID of the secondary vSwitch 2.

    vsw-bp1gzt31twhlo0sa5****
    AutoRenew

    boolean

    No

    Specifies whether to enable auto-renewal.

    Note

    This parameter is valid only when PayType is set to Prepaid.

    false

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The ID of the request.

    F5178C10-1407-4987-9133-DE4DC9119F75
    DBClusterId

    string

    The cluster ID.

    cc-bp1qx68m06981****
    OrderId

    string

    The order ID.

    21137950671****

    Examples

    Success response

    JSON format

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

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.