📣
TiDB Cloud Premium 开放公测中。为企业级工作负载提供无限扩展、即时弹性伸缩和高级安全保障。立即体验 →
​
​

TiDB API 概览



TiDB 提供了多种 API,可用于查询和运维集群、管理数据同步、监控系统状态等场景。本文介绍 TiDB Cloud 和 TiDB 的可用 API。

TiDB Cloud API (PREVIEW)

TiDB Cloud API 是一个 REST 接口。通过该 API,你可以以编程方式访问和操作 TiDB Cloud 中的各类管理资源,例如项目、集群、备份、恢复、导入、账单以及 Data Service。

API描述
v1beta1管理 TiDB Cloud Starter、Essential 与 Dedicated 集群,以及账单、Data Service 与 IAM 资源。
v1beta管理 TiDB Cloud 的项目、集群、备份、导入与恢复。

TiDB API

TiDB 为相关 TiDB 工具提供了多种 API。通过这些 API,你可以管理集群组件、监控系统状态,并控制数据同步工作流。

API描述
TiProxy API获取 TiProxy 配置、健康状况以及监控数据。
Data Migration API管理 DM-master 与 DM-worker 节点、数据源以及数据同步任务。
监控 API获取 TiDB Server 运行状态、数据表的存储信息以及 TiKV 集群的详细信息。
TiCDC API查询 TiCDC 节点状态并管理数据同步任务,包括任务的创建、暂停、恢复与更新等操作。
TiDB Operator API管理 Kubernetes 上的 TiDB 集群,包括集群部署、升级、扩缩容、备份与故障转移等操作。

文档内容是否有帮助?