API概览

云数据库ClickHouse云原生版集群提供以下API接口。

地域管理

API	描述
DescribeRegions	调用DescribeRegions接口查看云原生版的地域和可用区信息。

集群管理

API	描述
CheckCreateCluster	调用CheckCreateCluster接口对创建云原生版集群进行预检查，预判创建请求是否成功。
CreateCluster	调用CreateCluster接口创建一个云原生版集群。
ListClusters	调用ListClusters接口查看指定地域的云原生版集群信息。
DescribeCluster	调用DescribeCluster接口查看云原生版集群的信息。
DescribeClusterStatusSet	调用DescribeClusterStatusSet接口查看云原生版集群的所有状态信息。
ModifyClusterDescription	调用ModifyClusterDescription接口修改云原生版集群的描述。
DeleteCluster	调用DeleteCluster接口删除云原生版集群。
UpgradeCluster	调用UpgradeCluster接口为云数据库ClickHouse云原生版集群进行小版本升级。

计算组管理

API	描述
CheckCreateVirtualWareHouse	调用CheckCreateVirtualWareHouse接口对创建计算组进行预检查，预判创建请求是否成功。
CreateVirtualWareHouse	调用CreateVirtualWareHouse接口创建计算组。
ListVirtualWareHouses	调用ListVirtualWareHouses接口查看所有计算组信息。
ListVirtualWareHouseConfigs	调用ListVirtualWareHouseConfigs接口查看计算组的所有参数配置信息。
DescribeVirtualWareHouse	调用DescribeVirtualWareHouse接口查看指定的计算组信息。
DescribeVirtualWareHouseEndpointInfo	调用DescribeVirtualWareHouseEndpointInfo接口查看计算组的连接信息。
DescribeVirtualWareHouseClassSet	调用DescribeVirtualWareHouseClassSet接口查询所有计算组规格。
DescribeVirtualWareHouseStatusSet	调用DescribeVirtualWareHouseStatusSet接口查看计算组的所有状态信息。
CheckModifyVirtualWareHouseResource	调用CheckModifyVirtualWareHouseResource接口对计算组变配进行预检查，预判变配请求是否成功。
ModifyVirtualWareHouseResource	调用ModifyVirtualWareHouseResource接口对计算组变配。
RestartVirtualWareHouse	调用RestartVirtualWareHouse接口重启计算组。
ModifyVirtualWareHouseDescription	调用ModifyVirtualWareHouseDescription接口修改计算组的描述。
ModifyVirtualWareHouseConfig	调用ModifyVirtualWareHouseConfig接口修改计算组的参数配置信息。
AllocateVirtualWareHousePublicConnection	调用AllocateVirtualWareHousePublicConnection接口申请计算组的外网地址。
ReleaseVirtualWareHousePublicConnection	调用ReleaseVirtualWareHousePublicConnection接口释放计算组的外网地址。
CheckDeleteVirtualWareHouse	调用CheckDeleteVirtualWareHouse接口对删除计算组进行预检查，预判删除请求是否成功。
DeleteVirtualWareHouse	调用DeleteVirtualWareHouse接口删除计算组。
DescribeSlowQuery	调用DescribeSlowQuery接口查询云数据库ClickHouse云原生版集群计算组的慢查询。
DescribeSlowQueryTrend	调用DescribeSlowQueryTrend接口查询云数据库ClickHouse云原生版集群计算组的慢查询趋势。
DescribeRunningQuery	调用DescribeRunningQuery接口查询云数据库ClickHouse云原生版集群计算组正在进行的查询。
KillQuery	调用KillQuery接口对指定云数据库ClickHouse云原生版集群的单个计算组进行查询取消操作。
GetDistributedTablesBufferSize	调用GetDistributedTablesBufferSize接口统计云数据库clickhouse云原生版集群计算组的分布式表本地写入缓存的大小。

账号管理

API	描述
CreateAccount	调用CreateAccount接口创建数据库账号。
ListAccounts	调用ListAccounts接口查看所有数据库账号信息。
DescribeAccount	调用DescribeAccount接口查看指定数据库账号的信息。
ResetAccountPassword	调用ResetAccountPassword接口重置数据库账号的密码。
ModifyAccountDescription	调用ModifyAccountDescription接口修改数据库账号的描述。
ModifyAccountPrivilege	调用ModifyAccountPrivilege接口修改数据库账号的权限类型。
DeleteAccount	调用DeleteAccount接口删除数据库账号。

安全管理

API	描述
DescribeClusterSecurityInfo	调用DescribeClusterSecurityInfo接口查看白名单分组。
PatchClusterSecurityIPGroup	调用PatchClusterSecurityIPGroup接口在白名单分组中添加IP地址。
UpsertClusterSecurityIPGroup	调用UpsertClusterSecurityIPGroup接口重置白名单分组中的IP地址。
DeleteClusterSecurityIPGroup	调用DeleteClusterSecurityIPGroup接口删除白名单分组。