ti db list-db-cluster-branches

Lists branches for one TiDB Cloud Starter instance, with optional pagination. The command verifies that the parent cluster is Starter before listing branches.

Syntax

ti db list-db-cluster-branches
  --db-cluster-id <string>
  [--help]
  [--page-size <int32>]
  [--page-token <string>]
  [--version]

Options

• --db-cluster-id <string>: Starter DB cluster ID. [required]
• --help: Display help information.
• --page-size <int32>: Number of branches to request. If omitted or set to 0, the API returns at most 10. The API maximum is 100; values greater than 100 are set to 100.
• --page-token <string>: Page token returned by a previous list-db-cluster-branches call.
• --version: Display version information.

For options shared by all commands, see Global options.

Examples

• List cluster branches:

  # Return all branches that belong to the selected TiDB Cloud Starter instance.
  ti db list-db-cluster-branches --db-cluster-id "<cluster-id>"
  

Related documentation

• TiDB Cloud Starter CLI Command Reference