概述
腾讯云数据仓库 TCHouse-D(Tencent Cloud House-D,TCHouse-D)基于业内领先的 OLAP 数据库 Apache Doris 内核构建,兼容 MySQL 协议,融合云上大数据生态,提供丰富的集群管控能力及完善的巡检告警体系,为客户提供简单易用、轻松运维的云上全托管服务,助力客户快速进行实时 OLAP 数据分析。TCHouse-D 提供完善的 OpenAPI 接口,帮助您通过编程方式实现集群创建、配置变更、扩缩容、备份恢复及用户权限管理等操作。
本章节介绍的 TCHouse-D API 接口均为 API 3.0 接口。您可以调用 API 对腾讯云 TCHouse-D 进行操作,例如创建集群、修改配置、管理用户权限、查询实例状态及处理备份任务。TCHouse-D 支持的所有接口信息,请参见 API 概览。
术语表
TCHouse-D API 接口的常见术语如下表所示:
| 术语 | 描述 |
|---|---|
| 集群(Cluster) | TCHouse-D 的基本管理单元,由多个 FE 和 BE 节点组成,提供数据存储和分析能力。 |
| FE 节点 | Frontend 节点,负责集群的查询规划、元数据管理和负载均衡。 |
| BE 节点 | Backend 节点,负责数据存储和查询执行。 |
使用限制
对于具体的接口参数限制,请参考各接口文档中的参数说明。
API 快速入门
您可以使用 API Explorer 工具在线调用 API。本文以创建集群基础操作为例,通过 API Explorer 工具调用 API 接口的步骤如下:
- 进入 API Explorer 工具页面。更多 API Explorer 工具使用信息,请参见 使用 API Explorer。
- 调用 CreateInstanceNew,创建 TCHouse-D 集群。
- 调用 DescribeInstanceState,查询集群创建状态。
- 调用 DescribeInstance,查询集群详细信息。
- 调用 ScaleOutInstance,水平扩容集群节点。
- 调用 ModifyClusterConfigs,修改集群配置文件。