API 概覽

API標準及多語言預置SDK

本產品（clickhouse/2019-11-11）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。

在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。

自訂簽名情境

若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。

帳號與安全準備

阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。

網路管理

API	標題	API概述
CreatePortsForClickHouse	新增連接埠	開通指定雲資料庫ClickHouse叢集的MySQL或HTTPS連接埠。
ReleaseClusterPublicConnection	釋放叢集的公網串連地址	釋放指定雲資料庫ClickHouse叢集的公網串連地址。
AllocateClusterPublicConnection	對叢集開通公網	建立指定雲資料庫ClickHouse叢集的公網串連地址。
DescribeDBClusterNetInfoItems	查看網路資訊	查詢指定雲資料庫ClickHouse叢集的網路資訊。

帳號管理

API	標題	API概述
CreateSQLAccount	建立高許可權帳號或普通帳號	調用CreateSQLAccount介面為雲資料庫ClickHouse叢集建立高許可權帳號或普通帳號。
CreateAccountAndAuthority	建立帳號及許可權	建立帳號及許可權。
DescribeAccountAuthority	查看帳號許可權	查看帳號許可權。
ModifyAccountAuthority	修改帳號許可權	修改帳號許可權。

安全管理

API	標題	API概述
CreateMonitorDataReport	建立監控資料報告	建立監控資料報告。
CheckMonitorAlert	是否開通監控警示功能	調用CheckMonitorAlert介面校正指定雲資料庫ClickHouse叢集是否開通了ARMS（Application Real-Time Monitoring Service）服務提供的監控警示功能。

其他

API	標題	API概述
ModifyMinorVersionGreadeType	修改小版本升級類型	修改ClickHouse小版本升級類型（自動升級或手動升級）。

Others

API	標題	API概述
CancelActiveOperationTasks	取消尚未開始的營運任務	取消營運事件任務
CancelAppointmentElectZookeeperLeader	取消預約Zookeeper切主	取消預約ClickHouse社區相容版執行個體Zookeeper切主
CancelAppointmentRestartInstanceNodeList	取消預約重啟節點列表	取消預約重啟ClickHouse節點列表
CancelRestartInstance	CancelRestartInstance	調用CancelRestartInstance介面取消指定雲資料庫ClickHouse社區相容版叢集的預約重啟時間。
ChangeResourceGroup	修改ClickHouse社區相容版叢集所在資源群組	修改ClickHouse社區相容版叢集所在資源群組。
CheckClickhouseToRDS	檢查與RDS連通性	調用CheckClickhouseToRDS介面檢查雲資料庫ClickHouse社區相容版叢集與雲資料庫RDS MySQL的連通性。
CheckModifyConfigNeedRestart	查詢配置參數是否需要重啟	呼叫CheckModifyConfigNeedRestart介面查詢雲端資料庫ClickHouse社區相容版叢集在XML模式下配置參數的變更是否需要重啟。
CheckScaleOutBalanced	擴容檢查	對指定雲端資料庫 ClickHouse 叢集進行遷移擴容檢測。
CheckServiceLinkedRole	查新服務關聯角色（SLR）	查詢雲資料庫ClickHouse服務關聯角色。
CreateAccount	建立帳號	調用CreateAccount介面為指定雲資料庫ClickHouse叢集建立資料庫帳號。
CreateBackupPolicy	建立備份策略	建立備份策略。
CreateDBInstance	建立叢集	建立一個雲資料庫ClickHouse叢集。
CreateOSSStorage	建立冷儲存	建立冷儲存。
CreateRDSToClickhouseDb	建立同步任務	調用CreateRDSToClickhouseDb介面建立雲資料庫ClickHouse社區相容版同步任務。
CreateSLB	CreateSLB	調用CreateSLB介面為指定雲資料庫ClickHouse社區相容版叢集掛載SLB。
CreateServiceLinkedRole	建立服務關聯角色	建立服務關聯角色。
DeleteAccount	刪除帳號	刪除指定雲資料庫ClickHouse叢集的指定資料庫帳號。
DeleteBackupPolicy	刪除備份策略	刪除ClickHouse社區相容版備份策略
DeleteDBCluster	刪除叢集	釋放指定的隨用隨付雲資料庫ClickHouse叢集。
DeleteSLB	DeleteSLB	為指定雲資料庫ClickHouse社區相容版叢集釋放SLB。
DeleteSyndb	刪除同步任務	刪除同步資料庫的任務。
DescribeAccounts	查詢帳號資訊	查詢指定雲資料庫ClickHouse叢集的資料庫帳號資訊。
DescribeActiveOperationMaintainConf	查詢主動營運配置	查詢Clickhouse執行個體的主動營運配置。
DescribeActiveOperationTasks	查詢執行個體的營運事件詳情	查詢Clickhouse執行個體的主動營運任務。
DescribeAllDataSource	枚舉資料庫列表	枚舉執行個體下所有資料庫列表、表列表和列列表。
DescribeAllDataSources	查看資料來源	查看資料來源。
DescribeAutoRenewAttribute	查詢ClickHouse社區相容版執行個體自動續約資訊	查詢Clickhouse社區相容版叢集的自動續約狀態。
DescribeBackupPolicy	查看備份策略	查看指定雲資料庫ClickHouse叢集的備份設定。
DescribeBackups	查看備份組	查看指定雲資料庫ClickHouse叢集的備份組。
DescribeColumns	查看列	查看列。
DescribeConfigHistory	查看配置參數的變更記錄	調用DescribeConfigHistory介面查看雲資料庫ClickHouse社區相容版叢集配置參數的變更記錄。
DescribeConfigVersionDifference	查看配置參數變更前後的參數值	調用DescribeConfigVersionDifference介面查看雲資料庫ClickHouse社區相容版叢集配置參數變更前後的參數值。
DescribeDBClusterAccessWhiteList	查看叢集的IP白名單	查看指定雲資料庫ClickHouse叢集的IP白名單。
DescribeDBClusterAttribute	查看叢集的詳細屬性	查詢指定雲資料庫ClickHouse叢集的資訊。
DescribeDBClusterConfig	查看叢集參數配置資訊	調用DescribeDBClusterConfig介面查詢社區相容版叢集的參數配置資訊。
DescribeDBClusterConfigInXML	查詢XML模式下的配置參數	調用DescribeDBClusterConfigInXML介面查詢雲資料庫ClickHouse社區相容版叢集XML模式下的配置參數。
DescribeDBClusterNodeInfos	擷取執行個體節點資訊	擷取ClickHouse社區相容版執行個體節點資訊
DescribeDBClusterPerformance	查看效能資料	調用DescribeDBClusterPerformance介面查看雲資料庫ClickHouse社區相容版叢集的效能資料。
DescribeDBClusterStatusSet	查詢ClickHouse執行個體狀態集合	查詢Clickhouse社區相容版叢集的狀態集。
DescribeDBClusters	查詢叢集列表	查詢雲資料庫ClickHouse指定地區的叢集資訊。
DescribeDBConfig	查詢字典配置資訊	調用DescribeDBConfig介面查詢社區相容版叢集的配置資訊。
DescribeEventMetaInfo	查詢事件中心事件元資訊	查詢Clickhouse社區相容版叢集的營運事件元資訊。
DescribeOSSStorage	檢視冷存	檢視冷存。
DescribeProcessList	查看執行個體正在啟動並執行查詢	調用DescribeProcessList介面查詢雲資料庫ClickHouse社區相容版叢集正在啟動並執行查詢。
DescribeRegions	查看可選的地區和可用性區域	查詢雲資料庫ClickHouse所有地區和可用性區域的資訊。
DescribeSchemas	枚舉執行個體下所有資料庫列表	枚舉執行個體下所有資料庫列表。
DescribeSlowLogRecords	查看慢日誌明細	查看慢日誌明細。
DescribeSlowLogTrend	查看叢集慢日誌趨勢統計情況	查看叢集慢日誌趨勢統計情況。
DescribeSynDbTables	查看同步資料庫與表	查看同步資料庫與表。
DescribeSynDbs	查看同步db	查看同步db。
DescribeTables	查看錶資訊	調用DescribeTables介面查詢社區相容版叢集的表資訊。
DescribeTransferHistory	查看遷移記錄	查看遷移記錄。
DescribeUserEncryptionKeyList	查看KMS密鑰列表	查詢使用者KMS密鑰列表。
ElectZookeeperLeader	Zookeeper自動切主	ClickHouse社區相容版執行個體Zookeeper主動切主
KillProcess	終止進行中的任務	終止進行中的任務。
ListTagResources	查詢執行個體綁定的標籤列表	查詢雲資料庫ClickHouse叢集已綁定的標籤列表。
ModifyAccountDescription	修改帳號的備忘資訊	修改指定雲資料庫ClickHouse叢集的指定資料庫帳號描述。
ModifyActiveOperationMaintainConf	修改主動營運事件	修改Clickhouse社區相容版叢集的主動營運任務配置。
ModifyActiveOperationTasks	修改執行個體計劃內營運事件的切換時間	修改Clickhouse社區相容版叢集營運事件的切換時間
ModifyAutoRenewAttribute	修改ClickHouse社區相容版叢集自動續約狀態	修改Clickhouse社區相容版叢集的自動續約狀態。
ModifyBackupPolicy	修改備份策略	修改指定雲資料庫ClickHouse叢集的備份設定。
ModifyDBCluster	對叢集進行升降配	對叢集進行升降配。
ModifyDBClusterAccessWhiteList	修改白名單	修改指定雲資料庫ClickHouse叢集的IP白名單。
ModifyDBClusterConfig	修改叢集設定	修改叢集設定。
ModifyDBClusterConfigInXML	變更配置參數	變更指定雲資料庫ClickHouse社區相容版叢集的配置參數。
ModifyDBClusterDescription	修改叢集名稱	修改指定雲資料庫ClickHouse叢集的名稱。
ModifyDBClusterMaintainTime	修改執行個體叢集可維護時間段	修改指定雲資料庫ClickHouse叢集的可維護時間段。
ModifyDBConfig	ModifyDBConfig	The ModifyDBConfig operation modifies the dictionary configuration of a community-compatible cluster.
ModifyRDSToClickhouseDb	修改同步任務	調用ModifyRDSToClickhouseDb介面修改雲資料庫ClickHouse社區相容版叢集的同步任務。
ResetAccountPassword	重設帳號密碼	重設指定雲資料庫ClickHouse叢集的指定資料庫帳號密碼。
RestartInstance	重啟叢集	調用RestartInstance介面重啟指定雲資料庫ClickHouse叢集。
RestartInstanceNodeList	大量重啟執行個體節點	大量重啟ClickHouse社區相容版執行個體節點
TagResources	為ClickHouse叢集添加標籤	為雲資料庫ClickHouse叢集建立並綁定標籤。
TransferVersion	遷移版本	遷移版本。
UntagResources	將標籤從ClickHouse叢集上解除綁定	解除綁定雲資料庫ClickHouse叢集的標籤。
UpgradeMinorVersion	升級核心小版本	調用UpgradeMinorVersion介面升級指定雲資料庫ClickHouse社區相容版叢集的核心小版本。