📣

TiDB Cloud Premium is now in public preview. Unlimited growth, instant elasticity, advanced security for enterprise workloads. Try it out →

ticloud serverless describe

Get information about a TiDB Cloud Starter or TiDB Cloud Essential instance (such as the instance configurations and instance status):

ticloud serverless describe [flags]

Or use the following alias command:

ticloud serverless get [flags]

Examples

Get information about a TiDB Cloud Starter or TiDB Cloud Essential instance in interactive mode:

ticloud serverless describe

Get information about a TiDB Cloud Starter or TiDB Cloud Essential instance in non-interactive mode:

ticloud serverless describe --cluster-id <cluster-id>

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.

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.

If you have any questions or suggestions on the TiDB Cloud CLI, feel free to create an issue. Also, we welcome any contributions.