本产品（
云数据库 ClickHouse 版/2023-05-22）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
集群管理
| API | 标题 | API概述 |
|---|---|---|
| CreateDBInstance | 创建集群 | 调用CreateDBInstance接口创建ClickHouse企业版集群。 |
| DeleteDBInstance | 释放集群 | 调用DeleteDBInstance接口释放云数据库ClickHouse企业版集群。 |
| StartDBInstance | 启动集群 | 调用StartDBInstance接口启动云数据库ClickHouse企业版集群。 |
| RestartDBInstance | 重启集群 | 调用RestartDBInstance接口重启云数据库ClickHouse企业版集群。 |
| StopDBInstance | 暂停集群 | 调用StopDBInstance接口暂停云数据库ClickHouse企业版集群。 |
| ModifyDBInstanceClass | 修改集群弹性配置 | 调用ModifyDBInstanceClass接口修改集群的弹性配置。 |
| ModifyDBInstanceAttribute | 修改集群的配置属性 | 调用ModifyDBInstanceAttribute接口修改集群的配置属性。 |
| DescribeDBInstances | 查询集群列表 | 调用DescribeDBInstances接口查询集群列表。 |
| DescribeDBInstanceAttribute | 查询集群的详细信息 | 调用DescribeDBInstanceAttribute接口查询云数据库ClickHouse企业版集群的详细信息。 |
| UpgradeMinorVersion | 升级内核小版本 | 调用UpgradeMinorVersion接口升级指定云数据库ClickHouse企业版集群的内核小版本。 |
账号管理
| API | 标题 | API概述 |
|---|---|---|
| CreateAccount | 创建账号 | 调用CreateAccount接口为云数据库ClickHouse企业版集群创建数据库账号。 |
| DeleteAccount | 删除账号 | 调用DeleteAccount接口删除账号。 |
| ResetAccountPassword | 重置账号的密码 | 调用ResetAccountPassword接口重置云数据库ClickHouse企业版集群的数据库账号密码。 |
| ModifyAccountDescription | 修改账号备注 | 调用ModifyAccountDescription接口修改账号的备注信息。 |
| ModifyAccountAuthority | 修改账号的授权信息 | 调用ModifyAccountAuthority接口修改账号的授权信息。 |
| DescribeAccounts | 查询账号列表 | 调用DescribeAccounts接口查询指定云数据库ClickHouse集群的数据库账号列表。 |
| DescribeAccountAuthority | 查看账号权限 | 调用DescribeAccountAuthority接口查看账号权限。 |
数据库管理
| API | 标题 | API概述 |
|---|---|---|
| CreateDB | 创建数据库 | 调用CreateDB接口创建数据库。 |
| DeleteDB | 删除数据库 | 调用DeleteDB接口删除数据库。 |
| DescribeDBInstanceDataSources | 查询DB或者Table的数据结构 | 调用DescribeDBInstanceDataSources接口查询DB或者Table的数据结构。 |
网络管理
| API | 标题 | API概述 |
|---|---|---|
| CreateEndpoint | 申请外网地址 | 调用CreateEndpoint接口申请外网地址。 |
| DeleteEndpoint | 释放外网地址 | 调用DeleteEndpoint接口释放外网地址。 |
| ModifyDBInstanceConnectionString | 修改连接地址 | 调用ModifyDBInstanceConnectionString接口修改集群的连接地址。 |
| ModifySecurityIPList | 变更白名单 | 调用ModifySecurityIPList接口变更集群白名单设置。 |
| DescribeSecurityIPList | 查询白名单 | 调用DescribeSecurityIPList接口查询白名单。 |
| DescribeEndpoints | 查询集群访问地址 | 调用DescribeEndpoints接口查询集群的访问地址。 |
任务及日志管理
| API | 标题 | API概述 |
|---|---|---|
| DescribeProcessList | 查看正在运行中的查询 | 调用DescribeProcessList接口查看正在运行中的查询。 |
| KillProcess | 终止正在进行的任务 | 调用KillProcess接口终止正在进行的任务。 |
| DescribeSlowLogTrend | 查询慢日志趋势 | 调用DescribeSlowLogTrend接口查询慢日志趋势。 |
| DescribeSlowLogRecords | 查询慢日志明细 | 调用DescribeSlowLogRecords接口查询慢日志明细。 |