This topic describes the basic information and usage notes of ApsaraDB for ClickHouse API.
For more information about Alibaba Cloud APIs, see Overview of OpenAPI Explorer.
Basic information
Version description
Version | Description |
2019-11-11 | Recommended |
Endpoint description
You must use the endpoint based on the region of your instance to reduce the latency.
For example, if your instance resides in the China (Zhangjiakou) region, the virtual private cloud (VPC) endpoint of the China (Zhangjiakou) region is clickhouse-vpc.cn-zhangjiakou.aliyuncs.com.
User Identity
Identity | Supported |
Yes | |
(Recommended) RAM user | Yes |
(Recommended) RAM role | Yes |
API style
The remote procedure call (RPC) style is used.
Call methods
Call method | Supported | Description |
(Recommended) Alibaba Cloud SDKs | Yes | For more information about the programming languages supported by ApsaraDB for ClickHouse SDKs and methods to install dependencies, see ApsaraDB for ClickHouse SDKs. |
If the preceding methods cannot meet your business requirements, you can encapsulate custom API requests. However, this method is not recommended. For more information, see Custom encapsulation.
Precautions
If an error is returned after you call an API operation, check whether the request parameters and the parameter values are valid based on the returned error code. For more information, see ApsaraDB for ClickHouse - Error Codes.
You can also save the returned request ID or SDK error information and use the Alibaba Cloud OpenAPI Diagnostics tool to perform self-service diagnostics.