API概览 - 云数据库 ClickHouse

本产品（云数据库 ClickHouse 版/2019-11-11）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。

在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

地域管理

API	标题	API概述
DescribeRegions	查看可选的地域和可用区	查询云数据库ClickHouse所有地域和可用区的信息。

集群管理

API	标题	API概述
CreateDBInstance	创建集群	创建一个云数据库ClickHouse集群。
DeleteDBCluster	删除集群	释放指定的按量付费云数据库ClickHouse集群。
DescribeDBClusters	查询集群列表	查询云数据库ClickHouse指定地域的集群信息。
DescribeDBClusterAttribute	查看集群的详细属性	查询指定云数据库ClickHouse集群的信息。
DescribeDBClusterConfig	查看集群参数配置信息	调用DescribeDBClusterConfig接口查询社区兼容版集群的参数配置信息。
ModifyDBClusterConfig	修改集群配置	修改集群配置。
DescribeDBConfig	查询字典配置信息	调用DescribeDBConfig接口查询社区兼容版集群的配置信息。
ModifyDBCluster	对集群进行升降配	对集群进行升降配。
ModifyDBClusterDescription	修改集群名称	修改指定云数据库ClickHouse集群的名称。
ModifyDBClusterMaintainTime	修改实例集群可维护时间段	修改指定云数据库ClickHouse集群的可维护时间段。
DescribeAllDataSources	查看数据源	查看数据源。
DescribeAllDataSource	枚举数据库列表	枚举实例下所有数据库列表、表列表和列列表。
DescribeSchemas	枚举实例下所有数据库列表	枚举实例下所有数据库列表。
DescribeTables	查看表信息	调用DescribeTables接口查询社区兼容版集群的表信息。
DescribeColumns	查看列	查看列。
RestartInstance	重启集群	调用RestartInstance接口重启指定云数据库ClickHouse集群。
CheckScaleOutBalanced	扩容检查	对指定云数据库ClickHouse集群进行迁移扩容检测。
CreateOSSStorage	创建冷存储	创建冷存储。
DescribeOSSStorage	查看冷存	查看冷存。
CheckClickhouseToRDS	检查与RDS连通性	调用CheckClickhouseToRDS接口检查云数据库ClickHouse社区兼容版集群与云数据库RDS MySQL的连通性。
DescribeSynDbs	查看同步db	查看同步db。
DescribeSynDbTables	查看同步数据库与表	查看同步数据库与表。
DeleteSyndb	删除同步任务	删除同步数据库的任务。
DescribeTransferHistory	查看迁移记录	查看迁移记录。
TransferVersion	迁移版本	迁移版本。
CreateServiceLinkedRole	创建服务关联角色	创建服务关联角色。
KillProcess	终止正在进行的任务	终止正在进行的任务。
DescribeSlowLogRecords	查看慢日志明细	查看慢日志明细。
DescribeDBClusterPerformance	查看性能数据	调用DescribeDBClusterPerformance接口查看云数据库ClickHouse社区兼容版集群的性能数据。
UpgradeMinorVersion	升级内核小版本	调用UpgradeMinorVersion接口升级指定云数据库ClickHouse社区兼容版集群的内核小版本。
DescribeDBClusterConfigInXML	查询XML模式下的配置参数	调用DescribeDBClusterConfigInXML接口查询云数据库ClickHouse社区兼容版集群XML模式下的配置参数。
ModifyDBClusterConfigInXML	变更配置参数	调用ModifyDBClusterConfigInXML接口变更指定云数据库ClickHouse社区兼容版集群的配置参数。
CheckModifyConfigNeedRestart	查询配置参数是否需要重启	调用CheckModifyConfigNeedRestart接口查询云数据库ClickHouse社区兼容版集群在XML模式下配置参数的变更是否需要重启。
DescribeConfigHistory	查看配置参数的变更记录	调用DescribeConfigHistory接口查看云数据库ClickHouse社区兼容版集群配置参数的变更记录。
DescribeConfigVersionDifference	查看配置参数变更前后的参数值	调用DescribeConfigVersionDifference接口查看云数据库ClickHouse社区兼容版集群配置参数变更前后的参数值。
CreateRDSToClickhouseDb	创建同步任务	调用CreateRDSToClickhouseDb接口创建云数据库ClickHouse社区兼容版同步任务。
ModifyDBConfig	修改字典配置信息	调用ModifyDBConfig接口修改社区兼容版集群的字典配置信息。
ModifyRDSToClickhouseDb	修改同步任务	调用ModifyRDSToClickhouseDb接口修改云数据库ClickHouse社区兼容版集群的同步任务。
DescribeProcessList	查看实例正在运行的查询	调用DescribeProcessList接口查询云数据库ClickHouse社区兼容版集群正在运行的查询。

备份管理

API	标题	API概述
CreateBackupPolicy	创建备份策略	创建备份策略。
ModifyBackupPolicy	修改备份策略	修改指定云数据库ClickHouse集群的备份设置。
DescribeBackupPolicy	查看备份策略	查看指定云数据库ClickHouse集群的备份设置。
DescribeBackups	查看备份集	查看指定云数据库ClickHouse集群的备份集。

网络管理

API	标题	API概述
CreatePortsForClickHouse	新增端口	开通指定云数据库ClickHouse集群的MySQL或HTTPS端口。
ReleaseClusterPublicConnection	释放集群的公网连接地址	释放指定云数据库ClickHouse集群的公网连接地址。
AllocateClusterPublicConnection	对集群开通公网	创建指定云数据库ClickHouse集群的公网连接地址。
DescribeDBClusterNetInfoItems	查看网络信息	查询指定云数据库ClickHouse集群的网络信息。

账号管理

API	标题	API概述
DescribeAccounts	查询账号信息	查询指定云数据库ClickHouse集群的数据库账号信息。
CreateAccount	创建账号	调用CreateAccount接口为指定云数据库ClickHouse集群创建数据库账号。
CreateSQLAccount	创建高权限账号或普通账号	调用CreateSQLAccount接口为云数据库ClickHouse集群创建高权限账号或普通账号。
DeleteAccount	删除账号	删除指定云数据库ClickHouse集群的指定数据库账号。
ResetAccountPassword	重置账号密码	重置指定云数据库ClickHouse集群的指定数据库账号密码。
ModifyAccountDescription	修改账号的备注信息	修改指定云数据库ClickHouse集群的指定数据库账号描述。
CreateAccountAndAuthority	创建账号及权限	创建账号及权限。
DescribeAccountAuthority	查看账号权限	查看账号权限。
ModifyAccountAuthority	修改账号权限	修改账号权限。

安全管理

API	标题	API概述
DescribeDBClusterAccessWhiteList	查看集群的IP白名单	查看指定云数据库ClickHouse集群的IP白名单。
ModifyDBClusterAccessWhiteList	修改白名单	修改指定云数据库ClickHouse集群的IP白名单。
CreateMonitorDataReport	创建监控数据报告	创建监控数据报告。
CheckMonitorAlert	是否开通监控告警功能	调用CheckMonitorAlert接口校验指定云数据库ClickHouse集群是否开通了ARMS（Application Real-Time Monitoring Service）服务提供的监控告警功能。

其他

API	标题	API概述
CheckServiceLinkedRole	查新服务关联角色（SLR）	查询云数据库ClickHouse服务关联角色。
ModifyMinorVersionGreadeType	修改小版本升级类型	修改ClickHouse小版本升级类型（自动升级或手动升级）。