ti db describe-db-cluster

Describes one Starter cluster. Use --view FULL to request expanded fields. The command rejects the cluster if its API metadata does not verify it as Starter.

Syntax

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

Options

• --db-cluster-id <string>: Starter DB cluster ID. [required]
• --help: Display help information.
• --version: Display version information.
• --view <string>: Detail level: BASIC or FULL.

For options shared by all commands, see Global options.

Examples

• Describe a cluster:

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

Related documentation

• TiDB Cloud Starter CLI Command Reference