Managing DWS Tags

Function

After creating a DWS cluster, you can add identifiers to items such as the project name, service type, and background information using tags. 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. If you use tags in other cloud services, you are advised to create the same tag key-value pairs for cloud resources used by the same business to keep consistency.

DWS supports the following tags:

• Resource tags

  Non-global tags created on DWS

• Predefined tags

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

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

Concepts

You can use tags to classify and search for cloud resources.

A tag consists of a key and a value.

• A key in a tag can have multiple values.
• A cloud resource must have a unique key.

Application Scenarios

If you want to quickly locate a target cluster in a large number of clusters or manage clusters by project or business department, you can add tags.

Example: You can add the tag key project and tag value finance to a financial project cluster. You can then quickly search for the cluster in the cluster list using the tag.

Notes and Constraints

• 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 TMS.

Adding a Tag to a Cluster

1. Log in to the DWS console.
2. In the navigation pane on the left, choose Cluster > Cluster List.
3. Click the name of a cluster to which you want to add a tag and click the Tag tab.
4. Click Add Tag.
5. In the Add Tag dialog box, configure tag information. The tag value cannot be left blank.
   Figure 1 Adding a tag to a cluster
   

   Table 1 Tag parameters

   Parameter	Description	Example Value
   Tag key	You can: Select a predefined tag key and an existing resource tag key from the drop-down list of the text box. To add a predefined tag, you need to create one on TMS and select it from the drop-down list of Tag key. You can click View predefined tags to enter the Predefined Tags page of TMS. Then, click Create Tag to create a predefined tag. For more information, see Creating Predefined Tags in the Tag Management Service User Guide. Enter a tag key in the text box. A tag key can contain a maximum of 128 characters. It cannot be an empty string, start with _sys_, or start or end with a space. Only letters, digits, spaces, and the following characters are allowed: _ . : = + - @ A key must be unique in a given cluster.	key01
   Tag value	You can: Select a predefined tag value and resource tag value from the drop-down list of the text box. Enter a tag value in the text box. A tag value can contain a maximum of 255 characters. It cannot start or end with a space, but can be an empty string. Only letters, digits, spaces, and the following characters are allowed: _ . : = + - @	value01

6. Confirm the information and click OK. When the message "1 tag added successfully." is displayed in the upper right corner of the page, the tag has been added. You can view the tag in the tag list.

Searching for Clusters Based on Tags

You can quickly locate the desired cluster using tags.

1. Log in to the DWS console.
2. In the navigation pane on the left, choose Cluster > Cluster List.
3. Click the search box above the cluster list and find the Resource Tag filter.
4. Click the tag key you want to use to search for clusters and then select the corresponding tag value. The clusters that meet the search criteria are displayed in the cluster list. Click the search box again to add more tag filters.

   You can only select the keys and values that are available in the drop-down list of Resource Tag. If no tag key or value is available, create a tag for the cluster. For details, see Adding a Tag to a Cluster.

Modifying a Tag

1. Log in to the DWS console.
2. In the navigation pane on the left, choose Cluster > Cluster List.
3. Click the name of a cluster for which you want to modify the tag and click the Tag tab.
4. Locate the row that contains the tag to be modified, and click Edit in the Operation column. The Edit Tag dialog box is displayed.
5. Enter the new key value in the Value text box.
6. Click OK. If the value in the Value column of the tag list changes to the new value, the change is successful.

Deleting a Tag

1. Log in to the DWS console.
2. In the navigation pane on the left, choose Cluster > Cluster List.
3. Click the name of a cluster for which you want to delete the tag and click the Tag tab.
4. Locate the row that contains the tag you want to delete and click Delete in the Operation column. The Delete Tag dialog box is displayed.
5. Confirm the information, enter DELETE or click Auto Enter and click OK to delete the tag.
6. After the deletion is complete, check whether the tag disappears from the tag list. If it does, the deletion is successful.

Documentation

• Introduction to TMS: What Is Tag Management Service?
• Tag management APIs: Tag Management