本產品（
云數據庫 ClickHouse 版/2023-05-22）的OpenAPI采用RPC簽名風格，簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK，開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜，需花費 5個工作日左右。因此建議加入我們的服務釘釘群（78410016550），在專家指導下進行簽名對接。在使用API前，您需要準備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細節請參見獲取AccessKey。
集群管理
| API | 標題 | API概述 |
|---|---|---|
| CreateDBInstance | 創建集群 | 調用CreateDBInstance接口創建ClickHouse企業版集群。 |
| DeleteDBInstance | 釋放集群 | 調用DeleteDBInstance接口釋放云數據庫ClickHouse企業版集群。 |
| StartDBInstance | 啟動集群 | 調用StartDBInstance接口啟動云數據庫ClickHouse企業版集群。 |
| RestartDBInstance | 重啟集群 | 調用RestartDBInstance接口重啟云數據庫ClickHouse企業版集群。 |
| StopDBInstance | 暫停集群 | 調用StopDBInstance接口暫停云數據庫ClickHouse企業版集群。 |
| ModifyDBInstanceClass | 修改集群彈性配置 | 調用ModifyDBInstanceClass接口修改集群的彈性配置。 |
| ModifyDBInstanceAttribute | 修改集群的配置屬性 | 調用ModifyDBInstanceAttribute接口修改集群的配置屬性。 |
| DescribeDBInstances | 查詢集群列表 | 調用DescribeDBInstances接口查詢集群列表。 |
| DescribeDBInstanceAttribute | 查詢集群的詳細信息 | 調用DescribeDBInstanceAttribute接口查詢云數據庫ClickHouse企業版集群的詳細信息。 |
| UpgradeMinorVersion | 升級內核小版本 | 調用UpgradeMinorVersion接口升級指定云數據庫ClickHouse企業版集群的內核小版本。 |
賬號管理
| API | 標題 | API概述 |
|---|---|---|
| CreateAccount | 創建賬號 | 調用CreateAccount接口為云數據庫ClickHouse企業版集群創建數據庫賬號。 |
| DeleteAccount | 刪除賬號 | 調用DeleteAccount接口刪除賬號。 |
| ResetAccountPassword | 重置賬號的密碼 | 調用ResetAccountPassword接口重置云數據庫ClickHouse企業版集群的數據庫賬號密碼。 |
| ModifyAccountDescription | 修改賬號備注 | 調用ModifyAccountDescription接口修改賬號的備注信息。 |
| ModifyAccountAuthority | 修改賬號的授權信息 | 調用ModifyAccountAuthority接口修改賬號的授權信息。 |
| DescribeAccounts | 查詢賬號列表 | 調用DescribeAccounts接口查詢指定云數據庫ClickHouse集群的數據庫賬號列表。 |
| DescribeAccountAuthority | 查看賬號權限 | 調用DescribeAccountAuthority接口查看賬號權限。 |
數據庫管理
| API | 標題 | API概述 |
|---|---|---|
| CreateDB | 創建數據庫 | 調用CreateDB接口創建數據庫。 |
| DeleteDB | 刪除數據庫 | 調用DeleteDB接口刪除數據庫。 |
| DescribeDBInstanceDataSources | 查詢DB或者Table的數據結構 | 調用DescribeDBInstanceDataSources接口查詢DB或者Table的數據結構。 |
網絡管理
| API | 標題 | API概述 |
|---|---|---|
| CreateEndpoint | 申請外網地址 | 調用CreateEndpoint接口申請外網地址。 |
| DeleteEndpoint | 釋放外網地址 | 調用DeleteEndpoint接口釋放外網地址。 |
| ModifyDBInstanceConnectionString | 修改連接地址 | 調用ModifyDBInstanceConnectionString接口修改集群的連接地址。 |
| ModifySecurityIPList | 變更白名單 | 調用ModifySecurityIPList接口變更集群白名單設置。 |
| DescribeSecurityIPList | 查詢白名單 | 調用DescribeSecurityIPList接口查詢白名單。 |
| DescribeEndpoints | 查詢集群訪問地址 | 調用DescribeEndpoints接口查詢集群的訪問地址。 |
任務及日志管理
| API | 標題 | API概述 |
|---|---|---|
| DescribeProcessList | 查看正在運行中的查詢 | 調用DescribeProcessList接口查看正在運行中的查詢。 |
| KillProcess | 終止正在進行的任務 | 調用KillProcess接口終止正在進行的任務。 |
| DescribeSlowLogTrend | 查詢慢日志趨勢 | 調用DescribeSlowLogTrend接口查詢慢日志趨勢。 |
| DescribeSlowLogRecords | 查詢慢日志明細 | 調用DescribeSlowLogRecords接口查詢慢日志明細。 |