TiDB APIの概要
TiDBは、クラスタのクエリと操作、データレプリケーションの管理、システムステータスの監視などを行うためのさまざまなAPIを提供します。このドキュメントではTiDB CloudとTiDBセルフマネージド両方で利用可能なAPIの概要を説明します。 .
TiDB CloudAPI(ベータ版)
TiDB CloudAPIはRESTインターフェースAPIであり、プロジェクト、クラスタ、バックアップ、リストア、インポート、請求、データサービスリソースなど、 TiDB Cloud内の管理オブジェクトをプログラムで管理するためのアクセスを提供します。
| API | 説明 |
|---|
| v1beta2 | TiDB Cloud Premiumインスタンスを管理します。 |
| v1beta1 | TiDB Cloud Starter、 Essential、およびDedicatedクラスタに加え、課金、データサービス、 IAMリソースを管理します。 |
| v1beta | TiDB Cloudのプロジェクト、クラスター、バックアップ、インポート、およびリストアを管理します。 |
TiDBセルフマネージドAPI
TiDB Self-Managedは、TiDBツール用のさまざまなAPIを提供し、クラスタコンポーネントの管理、システムステータスの監視、データレプリケーションワークフローの制御を支援します。
| API | 説明 |
|---|
| TiProxy API | TiProxyの設定、稼働状況、および監視データにアクセスできます。 |
| データ移行API | DMマスターノードとDMワーカーノード、データソース、およびデータレプリケーションタスクを管理します。 |
| モニタリングAPI | TiDBサーバーの実行状況、テーブルstorage情報、およびTiKVクラスタの詳細を取得します。 |
| TiCDC API | TiCDCノードの状態を照会し、レプリケーションタスク(作成、一時停止、再開、更新操作など)を管理します。 |
| TiDB OperatorAPI | Kubernetes 上で TiDB クラスタを管理します。これには、デプロイ、アップグレード、スケーリング、バックアップ、フェイルオーバーなどが含まれます。 |