ti db describe-db-cluster

TiDB Cloud Starter インスタンスの情報を取得します。デフォルトの BASIC ビューでは、インスタンスの基本情報が返されます。TiDB Cloud API から取得可能な完全な詳細を要求するには、--view FULL を使用します。クラスターの API メタデータによって Starter であることを確認できない場合、このコマンドはそのクラスターを拒否します。

構文

ti db describe-db-cluster
  --db-cluster-id <string>
  [--help]
  [--version]
  [--view <string>]

オプション

• --db-cluster-id <string>: Starter DB クラスター ID。[required]
• --help: ヘルプ情報を表示します。
• --version: バージョン情報を表示します。
• --view <string>: 詳細レベル: BASIC または FULL。省略した場合、TiDB Cloud API は BASIC を使用します。

すべてのコマンドで共通のオプションについては、グローバルオプション を参照してください。

例

• TiDB Cloud Starter インスタンスの情報を取得します。

  # Return the instance state, placement, and connection metadata.
  ti db describe-db-cluster --db-cluster-id "<cluster-id>" --view FULL
  

関連ドキュメント

• TiDB Cloud Starter CLI コマンドリファレンス