ClickHouse提供以下API接口。

地域管理

API 描述
DescribeRegions 该接口用于查询可选的 ClickHouse 地域和可用区。

集群管理

API 描述
CreateDBCluster 调用CreateDBCluster接口创建一个ClickHouse集群。
DeleteDBCluster 该接口用于释放按量付费的 ClickHouse 集群。
DescribeDBClusters 该接口用于查询集群列表或被RAM授权的集群列表。
DescribeDBClusterAttribute 该接口用于查看指定实例的详细属性。
ModifyDBClusterDescription 该接口用于修改实例的备注名，方便实例的维护。
ModifyDBClusterMaintainTime 调用ModifyDBClusterMaintainTime接口修改ClickHouse实例可维护时间段。
DescribeDBClusterStatusSet 该接口用于查询集群状态集。
DescribeAutoRenewAttribute 该接口用于查询 ClickHouse 包年包月集群自动续费状态。
DescribeAllDataSource 调用DescribeAllDataSource接口枚举实例下所有Schema列表、Table列表和Columns列表
ModifyAutoRenewAttribute 该接口用于设置 ClickHouse 包年包月集群自动续费状态。

网络管理

API 描述
DescribeDBClusterNetInfoItems 该接口用于查询集群的网络信息。
AllocateClusterPublicConnection 该接口用于创建实例的公网连接地址
ReleaseClusterPublicConnection 该接口用于删除集群的公网地址

账号管理

API 描述
DescribeAccounts 该接口用于查询指定集群、指定数据库的账号列表信息或某个指定账号的信息。
CreateAccount 该接口用于为实例创建高权限账号。
DeleteAccount 该接口用于删除数据库高权限账号
ResetAccountPassword 重置高权限账号的密码
ModifyAccountDescription 该接口用于修改 ClickHouse 数据库账号的备注信息。

安全管理

API 描述
DescribeDBClusterAccessWhiteList 查看实例IP白名单。
ModifyDBClusterAccessWhiteList 修改白名单。

附录

API 描述
DescribeAllDataSource 枚举实例下所有Schema列表、Table列表和Columns列表。
DescribeDBInstanceAvailabilityDetail 查询实例可用性数据。获取查询时间段内的不可用时间范围。
DescribeDBClusterPerformance 查看实例性能数据。根据性能参数查看某个实例、某时间段范围内的性能监控数据。