All Products
Search

This Product

    ApsaraDB for ClickHouse:Integration overview

    Document Center

    ApsaraDB for ClickHouse:Integration overview

    Last Updated:Jun 02, 2026

    Learn how to call ApsaraDB for ClickHouse APIs by using OpenAPI Explorer, Alibaba Cloud SDKs, and other integration methods.

    OpenAPI

    OpenAPI Explorer is an all-in-one platform for API search, documentation, online debugging, SDK code samples, error diagnostics, and call statistics. Use it to call and test APIs across Alibaba Cloud services. What is OpenAPI?

    Versions

    Each ApsaraDB for ClickHouse cluster edition uses a different API version. Select the version that matches your edition.

    Version number

    Description

    2019-11-11

    Use this version to call APIs for Community-compatible Edition clusters.

    2023-05-22

    Use this version to call APIs for Enterprise Edition clusters.

    Online debugging

    You can debug ApsaraDB for ClickHouse APIs in OpenAPI Explorer. Before making calls, review the API versions, endpoints, and integration methods for ApsaraDB for ClickHouse.

    The left pane lists API categories such as Region management, Cluster management, and Compute group management. Select an API to view its description, configure parameters such as ZoneId and RegionId, and click Initiate Call to test it. The right pane shows parameter descriptions and example values.

    API debugging URLs

    ApsaraDB for ClickHouse is available in Community-compatible Edition and Enterprise Edition. Each edition has a separate debugging URL.

    Edition

    API debugging URL

    Community-compatible Edition

    API debugging URL for ApsaraDB for ClickHouse Community-compatible Edition

    Enterprise Edition

    API debugging URL for ApsaraDB for ClickHouse Enterprise Edition

    Endpoints

    To minimize latency, select an endpoint that is in the same region as your resources. For example, for an ApsaraDB for ClickHouse cluster in the China (Zhangjiakou) region, the public endpoint is clickhouse.cn-zhangjiakou.aliyuncs.com and the VPC endpoint is clickhouse-vpc.cn-zhangjiakou.aliyuncs.com.

    • Public endpoints are globally accessible.

    • VPC endpoints run on an isolated virtual network and offer the following benefits:

      • Higher security: accessible only from within the VPC.

      • Lower latency: internal network, unaffected by public network fluctuations.

      • Lower cost: internal traffic reduces data transfer costs.

    All supported regions and endpoints are listed in Service endpoints.

    Supported user identities

    OpenAPI Explorer uses your signed-in account for debugging by default. Because an Alibaba Cloud account has full API permissions, use a RAM user with minimum required permissions for API access and daily O&M. Grant the RAM user the permissions to manage ApsaraDB for ClickHouse. RAM authorization.

    Identity

    Supported

    Alibaba Cloud account

    Yes

    RAM user (Recommended)

    Yes

    RAM role (Recommended)

    Yes

    Integration methods

    ApsaraDB for ClickHouse supports multiple integration methods: Alibaba Cloud SDK, Terraform, Resource Orchestration Service (ROS), and custom encapsulation.

    Note

    SDKs simplify integration and are the recommended method for calling OpenAPI.

    Integration method

    Supported

    Alibaba Cloud SDK

    Yes

    Alibaba Cloud CLI

    Not supported

    Terraform

    Not supported

    Resource Orchestration Service (ROS)

    Partially supported

    Custom encapsulation

    Yes

    Alibaba Cloud SDK

    • Alibaba Cloud SDKs support Java, C#, Go, Python, Node.js, TypeScript, PHP, and C++. SDKs handle authentication and signing, so you can call APIs directly. Alibaba Cloud SDK.

    • You can use an Alibaba Cloud SDK to call ApsaraDB for ClickHouse APIs. Supported languages and installation steps are in the ApsaraDB for ClickHouse SDK overview.

    Alibaba Cloud CLI

    • Alibaba Cloud CLI lets you manage cloud resources from a shell by using the aliyun command. What is Alibaba Cloud CLI?.

    • You cannot use Alibaba Cloud CLI to call ApsaraDB for ClickHouse APIs.

    Terraform

    • Terraform is an open-source tool for provisioning and managing cloud infrastructure through templates. What is Alibaba Cloud Terraform?.

    • You cannot use Terraform to orchestrate ApsaraDB for ClickHouse APIs.

    Resource Orchestration Service (ROS)

    • ROS automates cloud resource provisioning through templates. Define resources such as ECS instances and RDS instances with their dependencies, and ROS creates and configures them automatically. What is Resource Orchestration Service?.

    • You can use ROS to call ApsaraDB for ClickHouse APIs. Supported resource types and data sources are listed in the ROS resource list.

    Custom encapsulation

    For native HTTP calls, implement the V3 signing algorithm and build requests manually. Request body and signing mechanism for V3.

    Usage notes

    If an API call returns an error, verify your request parameters against the Error code center.

    Use the RequestID or SDK error message from the response to diagnose issues on the Alibaba Cloud OpenAPI Diagnostic Platform.