All Products
Search
Document Center

ApsaraDB for ClickHouse:Connect to a cluster

Last Updated:Jul 17, 2026

ApsaraDB for ClickHouse supports connections through DMS, the ClickHouse command-line tool, and third-party clients such as DataGrip and DBeaver. This topic describes how to connect by using DMS.

Background information

DMS (Data Management Service) is an Alibaba Cloud graphical tool for managing relational and NoSQL databases. It supports data management, SQL operations, data import and export, database cloning, performance optimization, and security audits. In ApsaraDB for ClickHouse, you can use DMS to manage databases and tables and run online queries.

Prerequisites

You have completed the following steps in the quick start guide:

  • Create a cluster

  • Create an account

  • Configure a whitelist

    Note

    When you create an ApsaraDB for ClickHouse cluster, the system automatically adds a whitelist group named ali_dms_group to the ApsaraDB for ClickHouse cluster and adds the IP addresses of DMS servers to this group. If this process fails, you must add the IP addresses manually. For the IP addresses of DMS servers in different regions, see DMS IP Address Ranges.

Procedure

  1. Log on to the ApsaraDB for ClickHouse console.

  2. In the upper-left corner of the page, select the region where your cluster resides.

  3. On the Clusters page, find the Instance list for your cluster type, and then click the ID of your target cluster.

  4. On the Cluster Information page, click Log On to Database.

  5. Configure the following parameters.

    Parameter

    Description

    Example

    The database type

    The type of the ApsaraDB for ClickHouse cluster. The default value is ClickHouse. You do not need to change this setting.

    ClickHouse

    Region

    The region of the current ApsaraDB for ClickHouse cluster. The default value is automatically populated. You do not need to change this setting.

    Note

    To connect to an ApsaraDB for ClickHouse cluster in a different region, select the region from the drop-down list.

    China (Hangzhou)

    Instance ID

    The ID of the current ApsaraDB for ClickHouse cluster. The default value is automatically populated. You do not need to change this setting.

    Note

    To connect to a different ApsaraDB for ClickHouse cluster, select the cluster ID from the drop-down list.

    cc-bp16qwvp7hy8i****

    Database Account

    The account used to log on to the database.

    test

    Database Password

    The password of the database account.

    123456Aa

    Remember password

    Select Remember password to automatically log on to the ApsaraDB for ClickHouse cluster next time without re-entering your credentials.

    Select Remember password.

    Note
    • When you log on to an ApsaraDB for ClickHouse cluster through DMS for the first time, the control mode is set to Flexible Management by default. After you log on, you can change the control mode by editing the instance. For more information, see Edit an instance and Control modes.

    • After you configure the logon parameters, you can click Test Connection in the lower-left corner of the page to verify whether the cluster can be connected. If the test fails, check the cluster information based on the error message.

  6. Click Log On.

Next steps

Create a database

Related documents

To connect to an ApsaraDB for ClickHouse cluster by using other methods, see the following topics: