TiDB CloudAPI の概要 (ベータ版)

注記：

TiDB Cloud API はベータ版です。

TiDB Cloud APIは、 TiDB Cloud内の管理オブジェクトを管理するためのプログラム的なアクセスを提供するRESTインターフェースです。このAPIを使用すると、プロジェクト、クラスタ、バックアップ、リストア、インポート、課金、そしてデータサービス内のリソースなどのリソースを自動的かつ効率的に管理できます。

API には次の機能があります。

• JSON エンティティ。すべてのエンティティは JSON で表現されます。
• HTTPSのみ。APIへのアクセスはHTTPS経由でのみ可能であり、ネットワーク経由で送信されるすべてのデータはTLSで暗号化されます。
• キーベースのアクセスとダイジェスト認証。TiDB TiDB Cloud APIにアクセスする前に、APIキーを生成する必要があります（ APIキー管理を参照）。すべてのリクエストはHTTPダイジェスト認証を通じて認証されるため、APIキーがネットワーク経由で送信されることはありません。

TiDB Cloud API には、次の 2 つのバージョンがあります。

• v1ベータ1
  • クラスターレベルのリソース:
    • TiDB Cloud Starter または Essential クラスタ : TiDB Cloud Starter または Essential クラスターのクラスター、ブランチ、データ エクスポート タスク、およびデータ インポート タスクを管理します。
    • TiDB Cloud専用クラスタ : TiDB Cloud Dedicated クラスターのクラスター、リージョン、プライベート エンドポイント接続、およびデータ インポート タスクを管理します。
  • 組織またはプロジェクトレベルのリソース:
    • 請求する : TiDB Cloudクラスターの課金を管理します。
    • データサービス : TiDB Cloudクラスターのデータ サービス内のリソースを管理します。
    • IAMは : TiDB Cloudクラスターの API キーを管理します。
    • MSP（非推奨）
• v1ベータ
  • プロジェクト
  • クラスタ
  • バックアップ
  • インポート（非推奨）
  • 復元する