ticloud serverless branch list
q
List all branches for a TiDB Cloud Serverless cluster:
ticloud serverless branch list <cluster-id> [flags]
Or use the following alias command:
ticloud serverless branch ls <cluster-id> [flags]
Examples
List all branches for a TiDB Cloud Serverless cluster in interactive mode:
ticloud serverless branch list
List all branches for a specific TiDB Cloud Serverless cluster in non-interactive mode:
ticloud serverless branch list -c <cluster-id>
List all branches for a specific TiDB Cloud Serverless cluster in the JSON format:
ticloud serverless branch list <cluster-id> -o json
Flags
In non-interactive mode, you need to manually enter the required flags. In interactive mode, you can just follow CLI prompts to fill them in.
| Flag | Description | Required | Note |
|---|---|---|---|
| -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. |
| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. |
| -o, --output string | Specifies the output format (human by default). Valid values are human or json. To get a complete result, use the json format. | No | Works in both non-interactive and interactive modes. |
Inherited flags
| Flag | Description | Required | Note |
|---|---|---|---|
| --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. |
| -P, --profile string | Specifies the active user profile used in this command. | No | Works in both non-interactive and interactive modes. |
| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. |
Feedback
If you have any questions or suggestions on the TiDB Cloud CLI, feel free to create an issue. Also, we welcome any contributions.
ticloud serverless branch listwas last updated 11/21/2024, 8:00:57 AM: release-8.1: sync the cloud docs to the latest version (#19482)