TiDB APIの概要

TiDBは、クラスタのクエリと操作、データレプリケーションの管理、システムステータスの監視などのための様々なAPIを提供しています。このドキュメントでは、 TiDB CloudとTiDBセルフマネージド両方で利用可能なAPIの概要を説明します。

TiDB CloudAPI (ベータ版)

TiDB CloudAPIは、プロジェクト、クラスター、バックアップ、復元、インポート、課金、データサービスリソースなど、 TiDB Cloud内の管理オブジェクトを管理するためのプログラムによるアクセスを提供するRESTインターフェースです。

API	説明
v1ベータ1	TiDB Cloud Starter、Essential、Dedicated クラスターのほか、課金、データサービス、 IAMリソースも管理します。
v1ベータ	TiDB Cloudのプロジェクト、クラスター、バックアップ、インポート、復元を管理します。

TiDB Self-Managed は、クラスターコンポーネントの管理、システムステータスの監視、データレプリケーションワークフローの制御に役立つ TiDB ツール用のさまざまな API を提供します。

API	説明
TiProxy API	TiProxy の構成、ヘルスステータス、監視データにアクセスします。
データ移行API	DM マスターノードと DM ワーカーノード、データソース、およびデータレプリケーションタスクを管理します。
監視API	TiDBサーバーの実行ステータス、テーブルstorage情報、および TiKV クラスターの詳細を取得します。
TiCDC API	TiCDC ノードのステータスを照会し、操作の作成、一時停止、再開、更新などのレプリケーションタスクを管理します。
TiDB OperatorAPI	デプロイメント、アップグレード、スケーリング、バックアップ、フェイルオーバーなど、Kubernetes 上の TiDB クラスターを管理します。