云数据库ClickHouse社区兼容版集群提供以下API接口。

地域管理

API描述
DescribeRegions调用DescribeRegions接口查询社区兼容版的所有地域和可用区信息。

集群管理

API描述
CreateDBInstance调用CreateDBInstance接口创建一个社区兼容版集群。
DeleteDBCluster调用DeleteDBCluster接口释放指定的按量付费社区兼容版集群。
DescribeDBClusters调用DescribeDBClusters接口查询指定地域的社区兼容版集群信息。
DescribeDBClusterAttribute调用DescribeDBClusterAttribute接口查询指定社区兼容版集群的信息。
DescribeDBClusterConfig调用DescribeDBClusterConfig接口查询社区兼容版集群的参数配置信息。
ModifyDBClusterConfig调用ModifyDBClusterConfig接口修改社区兼容版集群的参数配置值。
DescribeDBConfig调用DescribeDBConfig接口查询社区兼容版集群的字典配置信息。
ModifyDBCluster调用ModifyDBCluster接口对社区兼容版集群进行变配。
ModifyDBClusterDescription调用ModifyDBClusterDescription接口修改指定社区兼容版集群的名称。
ModifyDBClusterMaintainTime调用ModifyDBClusterMaintainTime接口修改社区兼容版集群的可维护时间段。
DescribeAllDataSources调用DescribeAllDataSources或DescribeAllDataSource接口查询社区兼容版集群的数据库、表和列信息。
DescribeAllDataSource
DescribeSchemas调用DescribeSchemas接口查询社区兼容版集群的数据库信息。
DescribeTables调用DescribeTables接口查询社区兼容版集群的表信息。
DescribeColumns调用DescribeColumns接口查询社区兼容版集群指定数据库及表的列信息。
RestartInstance调用RestartInstance接口重启社区兼容版集群。
CheckScaleOutBalanced调用CheckScaleOutBalanced对社区兼容版集群进行迁移扩容检测。
CreateOSSStorage调用CreateOSSStorage接口开通社区兼容版集群的冷热分层存储功能。
DescribeOSSStorage调用DescribeOSSStorage接口查看社区兼容版集群是否开通了冷热分层存储。
CheckClickhouseToRDS调用CheckClickhouseToRDS接口判断云数据库ClickHouse社区兼容版集群能否与云数据库RDS实例连通。
DescribeSynDbs调用DescribeSynDbs接口查看云数据库ClickHouse与云数据库RDS MySQL的同步信息。
DescribeSynDbTables调用DescribeSynDbTables接口查看云数据库ClickHouse同步到云数据库ClickHouse的表信息。
DeleteSyndb调用DeleteSyndb接口删除云数据库RDS MySQL到云数据库ClickHouse的同步任务。
DescribeTransferHistory调用DescribeTransferHistory接口查询目标社区兼容版集群的数据迁移状态。
TransferVersion调用TransferVersion接口实现社区兼容版集群之间低版本向高版本的数据迁移。
CreateServiceLinkedRole调用CreateServiceLinkedRole接口创建服务关联角色。
KillProcess调用KillProcess接口停止社区兼容版集群正在运行的查询语句。
DescribeSlowLogRecords调用DescribeSlowLogRecords接口查询云数据库ClickHouse社区兼容版集群的慢查询任务。
DescribeSlowLogTrend调用DescribeSlowLogTrend接口查询社区兼容版集群的慢SQL趋势。
DescribeDBClusterPerformance调用DescribeDBClusterPerformance接口查看云数据库ClickHouse社区兼容版集群的性能数据。
UpgradeMinorVersion调用UpgradeMinorVersion接口升级指定云数据库ClickHouse社区兼容版集群的内核小版本。
DescribeDBClusterConfigInXML调用DescribeDBClusterConfigInXML接口查询云数据库ClickHouse社区兼容版集群XML模式下的配置参数。
ModifyDBClusterConfigInXML调用ModifyDBClusterConfigInXML接口变更指定云数据库ClickHouse社区兼容版集群的配置参数。
CheckModifyConfigNeedRestart调用CheckModifyConfigNeedRestart接口查询云数据库ClickHouse社区兼容版集群在XML模式下配置参数的变更是否需要重启。
DescribeConfigHistory调用DescribeConfigHistory接口查看云数据库ClickHouse社区兼容版集群配置参数的变更记录。
DescribeConfigVersionDifference调用DescribeConfigVersionDifference接口查看云数据库ClickHouse社区兼容版集群配置参数变更前后的参数值。
CreateSLB调用CreateSLB接口为指定云数据库ClickHouse社区兼容版集群挂载SLB。
DeleteSLB调用DeleteSLB接口为指定云数据库ClickHouse社区兼容版集群释放SLB。

备份管理

API描述
CreateBackupPolicy调用CreateBackupPolicy接口对社区兼容版集群进行备份设置。
DescribeBackups调用DescribeBackups接口查看社区兼容版集群的备份集。
DescribeBackupPolicy调用DescribeBackupPolicy接口查看社区兼容版集群的备份设置。
ModifyBackupPolicy调用ModifyBackupPolicy接口修改社区兼容版集群的备份设置。

网络管理

API描述
DescribeDBClusterNetInfoItems调用DescribeDBClusterNetInfoItems接口查询社区兼容版集群的网络信息。
AllocateClusterPublicConnection调用AllocateClusterPublicConnection接口创建社区兼容版集群的公网连接地址。
ReleaseClusterPublicConnection调用ReleaseClusterPublicConnection接口释放社区兼容版集群的公网连接地址。
CreatePortsForClickHouse调用CreatePortsForClickHouse接口开通社区兼容版集群的MySQL端口。

账号管理

API描述
DescribeAccounts调用DescribeAccounts接口查询社区兼容版集群的数据库账号信息。
CreateAccount调用CreateAccount接口为社区兼容版集群创建数据库账号。
CreateSQLAccount调用CreateSQLAccount接口为云数据库ClickHouse集群创建高权限账号或普通账号。
DeleteAccount调用DeleteAccount接口删除社区兼容版集群的指定数据库账号。
ResetAccountPassword调用ResetAccountPassword接口重置社区兼容版集群的指定数据库账号密码。
ModifyAccountDescription调用ModifyAccountDescription接口修改社区兼容版集群的指定数据库账号描述。
CreateAccountAndAuthority调用CreateAccountAndAuthority接口创建社区兼容版集群的数据库账号和设置权限。
DescribeAccountAuthority调用DescribeAccountAuthority接口查询单个社区兼容版集群指定数据库账号的权限。
ModifyAccountAuthority调用ModifyAccountAuthority接口修改单个社区兼容版集群指定数据库账号的权限。

安全管理

API描述
DescribeDBClusterAccessWhiteList用DescribeDBClusterAccessWhiteList接口查看社区兼容版集群的IP白名单。
ModifyDBClusterAccessWhiteList调用ModifyDBClusterAccessWhiteList接口修改社区兼容版集群的IP白名单。
CreateMonitorDataReport调用CreateMonitorDataReport接口开通社区兼容版集群基于ARMS（Application Real-Time Monitoring Service）服务提供的监控告警功能。
CheckMonitorAlert调用CheckMonitorAlert接口校验社区兼容版集群是否开通了ARMS（Application Real-Time Monitoring Service）服务提供的监控告警功能。