API标准及多语言预置SDK
本产品（clickhouse/2023-05-22）的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
集群管理
|
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接口查询慢日志明细。 |
备份管理
|
API |
标题 |
API概述 |
| ModifyBackupPolicy | 修改备份策略 | 修改ClickHouse企业版集群的备份策略。 |
| DescribeBackupPolicy | 查看备份策略 | 查看ClickHouse企业版集群的备份策略 |
| DeleteBackupPolicy | 删除备份策略 | 删除ClickHouse企业版集群的备份策略。 |
| CreateBackupPolicy | 创建备份策略 | 为指定的ClickHouse企业版集群创建备份策略。 |
| DescribeBackups | 查看备份集 | 查询ClickHouse企业版集群的备份集。 |
参数管理
|
API |
标题 |
API概述 |
| ModifyDBInstanceConfig | 修改实例配置 | 修改实例参数配置 |
| DescribeDBInstanceConfigChangeLog | 查询实例参数变更记录 | 查询实例参数配置记录 |
| DescribeDBInstanceConfig | 查询实例参数配置 | 查询实例参数配置 |
其他
|
API |
标题 |
API概述 |
| ChangeResourceGroup | 修改ClickHouse企业版实例所在资源组 | 修改ClickHouse企业版实例所在资源组。 |
| ListClickHouseDBTimezones | 获取ClickHouse时区枚举值列表 | 列举ClickHouse时区参数枚举值 |
| DeleteWhitelistTemplate | 删除白名单模板 | 删除白名单模板。 |
| CreateWhitelistTemplate | 创建白名单模板 | 新增白名单模板 |
| DetachWhitelistTemplateToInstance | 取消白名单模板和实例关联关系 | 取消白名单模板和实例关联关系 |
| UpdateWhitelistTemplate | 更新白名单模板 | 更新白名单模板。 |
| GetWhitelistTemplate | 查询白名单模板详情 | 查询白名单模板详情 |
| AttachWhitelistTemplateToInstance | 白名单模板关联实例 | 白名单模板关联实例。 |
| ListWhitelistTemplates | 查询实例关联的白名单模板 | 查询实例关联的白名单模板清单 |
| ListInstanceLinkedWhitelistTemplates | 查询实例关联的白名单模板 | 查询实例关联的白名单模板清单 |
| DescribeRegions | 获取ClickHouse企业版可用地域 | 查询云数据库ClickHouse企业版所有地域和可用区的信息 |
| DeleteLangfuseInstance | 释放Langfuse实例 | 释放Langfuse实例 |
| DescribeLangfuseSecurityIPList | 查询Langfuse白名单列表 | 查询Langfuse白名单列表 |
| DescribeLangfuseEndpoints | 查询Langfuse实例访问地址 | 查询Langfuse实例访问地址 |
| DeleteLangfuseOrgMembership | 从Langfuse组织中移除用户 | 从Langfuse组织中移除用户 |
| CreateLangfuseOrgMember | 将用户加入Langfuse组织 | 将用户加入Langfuse组织 |
| DescribeLangfuseOrgMemberships | 查询Langfuse组织成员信息 | 查询Langfuse组织成员信息 |
| DescribeLangfuseProjects | 查询Langfuse项目列表 | 查询Langfuse项目列表 |
| CreateLangfuseUser | 创建Langfuse用户 | 创建Langfuse用户 |
| DescribeLangfuseProjectMemberships | 查询Langfuse项目用户角色 | 查询Langfuse项目用户角色 |
| ResetLangfuseUserPassword | 重置Langfuse用户密码 | 重置Langfuse用户密码 |
| DeleteLangfuseOrg | 删除Langfuse组织 | 删除Langfuse组织 |
| DescribeLangfuseUser | 查询Langfuse用户详情 | 查询Langfuse用户详情 |
| CreateLangfuseOrg | 创建Langfuse组织 | 创建Langfuse组织 |
| CreateLangfuseProject | 创建Langfuse项目 | 创建Langfuse项目 |
| DeleteLangfuseProject | 删除Langfuse项目 | 删除Langfuse项目 |
| ModifyLangfuseProjectMembership | 修改用户在Langfuse项目中的权限 | 修改用户在Langfuse项目中的权限 |
| DescribeLangfuseOrgs | 查询Langfuse实例组织列表 | 查询Langfuse实例组织列表 |
| DescribeLangfuseUsers | 查询Langfuse用户列表 | 查询Langfuse用户列表 |
| DeleteLangfuseUser | 删除Langfuse用户 | 删除Langfuse用户 |
| ModifyLangfuseOrgMembership | 修改用户在Langfuse组织中的权限 | 修改用户在Langfuse组织中的权限 |
该文章对您有帮助吗？