云数据库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接口停止社区兼容版集群正在运行的查询语句。 |
备份管理
API | 描述 |
---|---|
CreateBackupPolicy | 调用CreateBackupPolicy接口对社区兼容版集群进行备份设置。 |
DescribeBackups | 调用DescribeBackups接口查看社区兼容版集群的备份集。 |
DescribeBackupPolicy | 调用DescribeBackupPolicy接口查看社区兼容版集群的备份设置。 |
ModifyBackupPolicy | 调用ModifyBackupPolicy接口修改社区兼容版集群的备份设置。 |
网络管理
API | 描述 |
---|---|
DescribeDBClusterNetInfoItems | 调用DescribeDBClusterNetInfoItems接口查询社区兼容版集群的网络信息。 |
AllocateClusterPublicConnection | 调用AllocateClusterPublicConnection接口创建社区兼容版集群的公网连接地址。 |
ReleaseClusterPublicConnection | 调用ReleaseClusterPublicConnection接口释放社区兼容版集群的公网连接地址。 |
CreatePortsForClickHouse | 调用CreatePortsForClickHouse接口开通社区兼容版集群的MySQL端口。 |
账号管理
API | 描述 |
---|---|
DescribeAccounts | 调用DescribeAccounts接口查询社区兼容版集群的数据库账号信息。 |
CreateAccount | 调用CreateAccount接口为社区兼容版集群创建数据库账号。 |
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)服务提供的监控告警功能。 |