本文為您介紹使用雲資料庫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。 |
線上調試
雲資料庫ClickHouse在OpenAPI門戶提供API調試等功能。在調用前，您需要瞭解雲資料庫ClickHouse提供的版本、存取點說明、整合方式等資訊。
調試入口
雲資料庫ClickHouse分為社區相容版和企業版，每個版本API的調試入口不同，請您根據自己的版本，選擇合適的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、Resource Orchestration Service和自訂封裝這幾種整合方式，您可以根據業務的實際需要進行選擇。
SDK便於整合，是OpenAPI最好的調用方式，推薦您選擇使用SDK。
整合方式名稱 | 支援與否 |
阿里雲SDK | 支援 |
阿里雲CLI | 暫不支援 |
Terraform | 暫不支援 |
Resource Orchestration Service | 部分支援 |
自訂封裝 | 支援 |
阿里雲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是一種開源工具，用於安全高效地預覽，配置和管理雲基礎架構和資源。它與阿里雲的Resource Orchestration Service服務的運行機制類似，通過將模板轉化為內部資料後完成OpenAPI調用。更多詳情，請參見什麼是Terraform。
暫不支援使用Terraform編排雲資料庫ClickHouse的OpenAPI。
Resource Orchestration Service
Resource Orchestration Service服務ROS（Resource Orchestration Service）是阿里雲提供的一項簡化雲端運算資源管理的服務。開發人員和管理員可以編寫模板，在模板中定義所需的阿里雲資源（例如：ECS執行個體、RDS資料庫執行個體）、資源間的依賴關係等。ROS的編排引擎將根據模板自動完成所有資源的建立和配置，實現自動化部署及營運。更多詳情，請參見什麼是Resource Orchestration Service服務。
支援通過Resource Orchestration Service服務ROS調用雲資料庫ClickHouse的OpenAPI，支援的部分普通資源和資料資源清單，請參見Resource Orchestration Service列表。
自訂封裝
您可以參考SDK部分的V3簽名文檔自訂封裝請求來訪問阿里雲OpenAPI。原生HTTP調用需要您自己實現簽名演算法，並構建自訂請求，發起HTTP調用。有關簽名機制的更多詳細資料，請參見V3版本請求體&簽名機制。
注意事項
如果調用API後返回錯誤，您需要根據返回的錯誤碼提示檢查傳入的請求參數及其取值是否正確，更多資訊請參見錯誤碼中心。
您也可以記錄下調用返回的RequestID或SDK報錯資訊，通過阿里雲OpenAPI診斷平台進行自助診斷。