Help Center/CloudTable Service/User Guide/Using ClickHouse/Managing ClickHouse Clusters/Managing ClickHouse Cluster Tags
Updated on 2025-12-29 GMT+08:00
View PDF

Managing ClickHouse Cluster Tags

Tag Overview

A tag is a key-value pair customized by users and used to classify and search for cloud resources. A tag consists of a tag key and a tag value.

On CloudTable, after creating a cluster, you can add identifiers to items such as the project name, service type, and background information using tags. If you use tags in other cloud services, you are advised to create the same tags (same key-value pairs) for the cloud resources used by the same service to ensure consistency.

CloudTable supports the following tags:

  • Resource tags

    Non-global tags created in CloudTable.

  • Predefined tags

    Predefined tags created on Tag Management Service (TMS). These tags are global tags.

    For details about predefined tags, see the Tag Management Service User Guide.

In CloudTable, tags can be added to the following resources:
  • Clusters

    Tags can be added to a cluster when the cluster is being created or after it is successfully created. You can search for the cluster in the cluster list using tags.

    Each cluster can have a maximum of 20 tags.

    After you add tags to a cluster and then create a snapshot for the cluster, the tags cannot be restored if you use the snapshot to restore the cluster. Instead, you need to add tags again.

    When a cluster is deleted, non-predefined tags associated with the cluster are also deleted. Predefined tags need to be deleted on the TMS console.

    If you create a predefined tag that is identical to an existing predefined tag, the existing predefined tag will be overwritten. If you create a predefined tag that has the same key but different value, the new predefined tag will be created.

Adding a Tag to a Cluster

  1. Log in to the CloudTable console.
  2. Select a region in the upper left corner.
  3. Select the cluster to which you want to add a tag and choose Cluster Name > Tag Management > Add Tag. The Add Tag dialog box is displayed.
  4. Configure the tag parameters in the Add Tag dialog box.

    Figure 1 Adding/Editing a tag
    Table 1 Tag parameters

    Parameter

    Parameter description

    Example Value

    Key

    You can:

    • Select a predefined tag key or an existing resource tag key from the drop-down list of the text box.
      NOTE:

      To add a predefined tag, you need to create one on TMS and then select it from the tag key drop-down list. You can click Create Predefined Tags to go to the Predefined Tags page of the TMS console. Then, click Create Tag in the upper corner of the page to create a predefined tag.

    • Enter a tag key in the text box.
      NOTE:

      A key must be unique in a given cluster.

      A tag key can contain letters, digits, spaces, and special characters (_.:=+-@), but cannot start or end with a space or start with _sys_.

    key01

    Value

    You can specify the tag value in either of the following ways:

    • Select a predefined tag value or resource tag value from the drop-down list of the text box.
    • Enter a tag value in the text box.
      NOTE:

      A tag value can contain letters, digits, spaces, and special characters (_.:=+-@).

    value01

  5. Click OK. The new tag is displayed on the Tag Management page.

    You can also add cluster tags when creating a cluster.