文档

集成概览

更新时间:

本文为您介绍使用云数据库ClickHouse OpenAPI的基本信息及注意事项。

OpenAPI介绍

为了能够让您快速高效地学习和使用云产品OpenAPI,阿里云提供了OpenAPI网站。它是一款集OpenAPI智能搜索、文档、在线调试、SDK获取、CodeSample、调用出错诊断、调用统计为一体的产品。您可以在OpenAPI门户中调用阿里云各云产品开放的OpenAPI,查看OpenAPI请求和返回结果。此外,OpenAPI门户会自动生成相应的SDK调用示例,帮助您快速使用阿里云产品。更多信息,请参见什么是 OpenAPI

版本说明

阿里云OpenAPI通过版本号管控不同架构的云数据库ClickHouse集群的API,请您根据自己的集群类型选择合适版本的API。

版本号

说明

2019-11-11

社区兼容版集群使用该版本号调用API。

2023-05-22

企业版集群使用该版本号调用API。

2022-01-01

云原生版集群使用该版本号调用API。

在线调试

云数据库ClickHouse在OpenAPI门户提供API调试等功能。在调用前,您需要了解云数据库ClickHouse提供的版本、接入点说明、集成方式等信息。

image

调试入口

云数据库ClickHouse分为社区兼容版、企业版和云原生版,每个版本API的调试入口不同,请您根据自己的版本,选择合适的API调试入口。

集群版本

调试入口

社区兼容版

云数据库ClickHouse社区兼容版调试API入口

企业版

云数据库ClickHouse企业版调试API入口

云原生版

云数据库ClickHouse社区兼容版调试API入口

接入点说明

根据相关资源所在地域,选择对应的接入地址,以获得最低延迟。例如华北3(张家口)云数据库ClickHouse的公网接入地址为clickhouse.cn-zhangjiakou.aliyuncs.com,VPC接入地址为clickhouse-vpc.cn-zhangjiakou.aliyuncs.com

  • 公网接入地址在全球都可访问。

  • VPC(Virtual Private Cloud)隔离了虚拟网络,每个VPC对应一个虚拟化网络。VPC地址的优势:

    • 高安全性:VPC接入地址只能在VPC内部访问,提供更高的安全性和隐私性。

    • 更快的响应速度:由于VPC接入地址在VPC内部网络中运行,其响应速度通常比公网接入地址更快,并且可以避免公网延迟和带宽限制等问题。

    • 更低的成本:VPC接入地址可以使用内部网络通信。

更多信息,请参见服务接入点

支持的用户身份

当您登录OpenAPI网站后,OpenAPI默认使用您所登录的账号进行在线OpenAPI调试。由于阿里云账号拥有所有API的访问权限,存在较高风险,因此不建议您使用阿里云账号在线调试API。强烈建议您创建并使用RAM用户进行API访问或日常运维。请根据业务的实际情况按需分配权限后进行API调用。RAM用户需具备操作云数据库ClickHouse的权限。具体操作,请参见授权信息

用户身份

支持情况

阿里云账号

支持

RAM用户(推荐)

支持

RAM角色(推荐)

支持

集成方式

云数据库ClickHouse提供阿里云SDK、Terraform、资源编排和自定义封装这几种集成方式,您可以根据业务的实际需要进行选择。

说明

SDK便于集成,是OpenAPI最好的调用方式,推荐您选择使用SDK。

集成方式名称

支持与否

阿里云SDK

支持

阿里云CLI

暂不支持

Terraform

部分支持

资源编排

部分支持

自定义封装

支持

阿里云SDK

  • 阿里云为您提供了多种编程语言(Java、C#、Go、Python、Node.js、TypeScript、PHP、C++等)的SDK。SDK屏蔽了OpenAPI实现细节,统一身份、认证及签名规则。您只需要集成SDK,通过SDK直接调用OpenAPI。关于更多阿里云SDK的介绍,请参见阿里云SDK

  • 支持通过阿里云SDK调用云数据库ClickHouse的OpenAPI。支持的语言及依赖安装方法,请参见云数据库ClickHouse SDK概览

阿里云CLI

  • 阿里云CLI命令行工具可以帮您在命令行Shell中,使用aliyun命令与阿里云服务进行交互,管理云服务资源。有关阿里云CLI的更多详情,请参见什么是阿里云CLI

  • 暂不支持使用阿里云CLI调用云数据库ClickHouse的OpenAPI。

Terraform

  • Terraform是一种开源工具,用于安全高效地预览,配置和管理云基础架构和资源。它与阿里云的资源编排服务的运行机制类似,通过将模板转化为内部数据后完成OpenAPI调用。更多详情,请参见什么是Terraform

  • 支持使用Terraform编排云数据库ClickHouse的OpenAPI,支持的部分普通资源和数据资源清单,请参见Terraform资源列表

资源编排ROS

  • 资源编排服务ROS(Resource Orchestration Service)是阿里云提供的一项简化云计算资源管理的服务。开发者和管理员可以编写模板,在模板中定义所需的阿里云资源(例如:ECS实例、RDS数据库实例)、资源间的依赖关系等。ROS的编排引擎将根据模板自动完成所有资源的创建和配置,实现自动化部署及运维。更多详情,请参见什么是资源编排服务

  • 支持通过资源编排服务ROS调用云数据库ClickHouse的OpenAPI,支持的部分普通资源和数据资源清单,请参见资源编排列表

自定义封装

您可以参考SDK部分的V3签名文档自定义封装请求来访问阿里云OpenAPI。原生HTTP调用需要您自己实现签名算法,并构建自定义请求,发起HTTP调用。有关签名机制的更多详细信息,请参见V3版本请求体&签名机制

注意事项

如果调用API后返回错误,您需要根据返回的错误码提示检查传入的请求参数及其取值是否正确,更多信息请参见错误码中心

您也可以记录下调用返回的RequestID或SDK报错信息,通过阿里云OpenAPI诊断平台进行自助诊断。

  • 本页导读 (1)