ticloud serverless update

Update a TiDB Cloud Serverless cluster:

ticloud serverless update [flags]

Examples

Update a TiDB Cloud Serverless cluster in interactive mode:

ticloud serverless update

Update the name of a TiDB Cloud Serverless cluster in non-interactive mode:

ticloud serverless update -c <cluster-id> --display-name <new-display-mame>

Update labels of a TiDB Cloud Serverless cluster in non-interactive mode

ticloud serverless update -c <cluster-id> --labels "{\"label1\":\"value1\"}"

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.

FlagDescriptionRequiredNote
-c, --cluster-id stringSpecifies the ID of the cluster.YesOnly works in non-interactive mode.
-n --display-name stringSpecifies a new name for the cluster.NoOnly works in non-interactive mode.
--labels stringSpecifies new labels for the cluster.NoOnly works in non-interactive mode.
--disable-public-endpointDisables the public endpoint of the cluster.NoOnly works in non-interactive mode.
-h, --helpShows help information for this command.NoWorks in both non-interactive and interactive modes.

Inherited flags

FlagDescriptionRequiredNote
--no-colorDisables color in output.NoOnly works in non-interactive mode. In interactive mode, disabling color might not work with some UI components.
-P, --profile stringSpecifies the active user profile used in this command.NoWorks in both non-interactive and interactive modes.
-D, --debugEnables debug mode.NoWorks 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.

Was this page helpful?