本产品（
云数据库 ClickHouse 版/2022-01-01）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
地域管理
| API | 标题 | API概述 |
|---|---|---|
| DescribeRegions | 查看可选的地域和可用区 | 调用DescribeRegions接口查询云数据库ClickHouse云原生版的地域和可用区信息。 |
集群管理
| API | 标题 | API概述 |
|---|---|---|
| CheckCreateCluster | 对创建集群进行预检查 | 调用CheckCreateCluster接口对创建云数据库ClickHouse云原生版集群进行预检查，预判创建请求是否成功。 |
| CreateCluster | 创建集群 | 调用CreateCluster接口创建一个云数据库ClickHouse云原生版集群。 |
| ListClusters | 查看指定地域集群信息 | 调用ListClusters接口查看指定地域的云数据库ClickHouse云原生版集群信息。 |
| DescribeCluster | 查看集群信息 | 调用DescribeCluster接口查看云数据库ClickHouse云原生版集群的信息。 |
| DescribeClusterStatusSet | 查看集群状态信息 | 调用DescribeClusterStatusSet接口查看云数据库ClickHouse云原生版集群的所有状态信息。 |
| ModifyClusterDescription | 修改集群描述 | 调用ModifyClusterDescription接口修改云数据库ClickHouse云原生版集群的描述。 |
| DeleteCluster | 释放集群 | 调用DeleteCluster接口释放指定云数据库ClickHouse云原生版的按量付费集群。 |
| UpgradeCluster | 升级小版本 | 调用UpgradeCluster接口为云数据库ClickHouse云原生版集群进行小版本升级，主要包含bug修复。 |
计算组管理
| API | 标题 | API概述 |
|---|---|---|
| CheckCreateVirtualWareHouse | 对创建计算组进行预检查 | 调用CheckCreateVirtualWareHouse接口对创建计算组进行预检查，预判创建请求是否成功。 |
| CreateVirtualWareHouse | 对创建计算组进行预检查 | 调用CreateVirtualWareHouse接口为云数据库ClickHouse云原生版集群创建计算组。 |
| ListVirtualWareHouses | 查看所有计算组信息 | 调用ListVirtualWareHouses接口查看云数据库ClickHouse云原生版集群的所有计算组信息。 |
| ListVirtualWareHouseConfigs | 查看指定计算组的参数配置信息 | 调用ListVirtualWareHouseConfigs接口查看云数据库ClickHouse云原生版集群指定计算组的所有参数配置信息。 |
| DescribeVirtualWareHouse | 查看指定的计算组信息 | 调用DescribeVirtualWareHouse接口查看云数据库ClickHouse云原生版集群的指定计算组信息。 |
| DescribeVirtualWareHouseEndpointInfo | 查看计算组的连接信息 | 调用DescribeVirtualWareHouseEndpointInfo接口查看计算组的连接信息。 |
| DescribeVirtualWareHouseClassSet | 查询所有计算组规格 | 调用DescribeVirtualWareHouseClassSet接口查询云数据库ClickHouse云原生版支持的所有计算组规格。 |
| DescribeVirtualWareHouseStatusSet | 查看计算组的状态信息 | 调用DescribeVirtualWareHouseStatusSet接口查看云原生版集群计算组的所有状态信息。 |
| CheckModifyVirtualWareHouseResource | 对计算组变配进行预检查 | 调用CheckModifyVirtualWareHouseResource接口对计算组变配进行预检查，预判变配请求是否成功。 |
| ModifyVirtualWareHouseResource | 对计算组变配 | 调用ModifyVirtualWareHouseResource接口对云数据库ClickHouse云原生版集群的指定计算组变配。 |
| RestartVirtualWareHouse | 重启计算组 | 调用RestartVirtualWareHouse接口重启计算组。本接口仅适用于云数据库ClickHouse的云原生版集群。 |
| ModifyVirtualWareHouseDescription | 修改计算组的描述 | 调用ModifyVirtualWareHouseDescription接口修改云数据库ClickHouse云原生版集群指定计算组的描述。 |
| ModifyVirtualWareHouseConfig | 修改计算组的参数配置信息 | 调用ModifyVirtualWareHouseConfig接口修改云原生版集群指定计算组的参数配置信息。 |
| AllocateVirtualWareHousePublicConnection | 申请计算组的外网地址 | 调用AllocateVirtualWareHousePublicConnection接口申请云原生版集群指定计算组的外网地址。 |
| ReleaseVirtualWareHousePublicConnection | 释放计算组的外网地址 | 调用ReleaseVirtualWareHousePublicConnection接口释放云数据库ClickHouse云原生版集群指定计算组的外网地址。 |
| CheckDeleteVirtualWareHouse | 对删除计算组进行预检查 | 调用CheckDeleteVirtualWareHouse接口对删除计算组进行预检查，预判删除请求是否成功。 |
| DeleteVirtualWareHouse | 删除计算组 | 调用DeleteVirtualWareHouse接口删除云数据库ClickHouse云原生版集群的指定计算组。 |
| DescribeSlowQuery | 查询计算组的慢查询 | 调用DescribeSlowQuery接口对指定云数据库ClickHouse云原生版的单个计算组进行慢查询明细诊断操作。 |
| DescribeSlowQueryTrend | 查询计算组的慢查询趋势 | 调用DescribeSlowQueryTrend接口对指定云数据库ClickHouse云原生版的单个计算组进行慢查询趋势诊断操作。 |
| DescribeRunningQuery | 查询计算中正在运行的查询 | 调用DescribeRunningQuery接口对指定云数据库ClickHouse云原生版的单个计算组进行正在运行查询查看操作。 |
| KillQuery | 取消查询操作 | 调用KillQuery接口对指定云数据库ClickHouse云原生版的单个计算组进行查询取消操作。 |
| GetDistributedTablesBufferSize | 统计计算组中分布式表本地写入缓存的大小 | 调用GetDistributedTablesBufferSize接口对指定云数据库ClickHouse云原生版的单个计算组进行分布式表本地写入缓存大小统计操作。 |
账号管理
| API | 标题 | API概述 |
|---|---|---|
| CreateAccount | 创建账号 | 调用CreateAccount接口为云数据库ClickHouse云原生版集群创建数据库账号。 |
| ListAccounts | 查看所有账号信息 | 调用ListAccounts接口查看云数据库ClickHouse云原生版集群的所有数据库账号信息。 |
| DescribeAccount | 查看指定账号信息 | 调用DescribeAccount接口查看云数据库ClickHouse云原生版集群的指定数据库账号信息。 |
| ResetAccountPassword | 重置账号密码 | 调用ResetAccountPassword接口重置数据库账号的密码。本接口仅适用于云数据库ClickHouse的云原生版集群。 |
| ModifyAccountDescription | 修改账号描述 | 调用ModifyAccountDescription接口修改云数据库ClickHouse云原生版集群指定数据库账号的描述。 |
| ModifyAccountPrivilege | 修改账号权限类型 | 调用ModifyAccountPrivilege接口修改云数据库ClickHouse云原生版集群指定数据库账号的权限类型。 |
| DeleteAccount | 删除指定账号 | 调用DeleteAccount接口删除云数据库ClickHouse云原生版集群的指定数据库账号。 |
安全管理
| API | 标题 | API概述 |
|---|---|---|
| DescribeClusterSecurityInfo | 查看白名单分组 | 调用DescribeClusterSecurityInfo接口查看云数据库ClickHouse云原生版集群的白名单分组。 |
| PatchClusterSecurityIPGroup | 在白名单分组中添加IP地址 | 调用PatchClusterSecurityIPGroup接口在白名单分组中添加IP地址。本接口仅适用于云数据库ClickHouse的云原生版集群。 |
| UpsertClusterSecurityIPGroup | 重置白名单分组中的IP地址 | 调用UpsertClusterSecurityIPGroup接口重置白名单分组中的IP地址。本接口仅适用于云数据库ClickHouse的云原生版集群。 |
| DeleteClusterSecurityIPGroup | 删除白名单分组 | 调用DeleteClusterSecurityIPGroup接口删除云数据库ClickHouse云原生版集群的指定白名单分组。 |