Help Center/ Distributed Message Service for Kafka/ User Guide/ Managing Instances/ Configuring Kafka Instance Tags
Updated on 2025-09-18 GMT+08:00
View PDF
Share

Configuring Kafka Instance Tags

Tags facilitate Kafka instance identification and management.

If your organization has configured tag policies for DMS for Kafka, add tags to Kafka instances based on the tag policies. If a tag added does not comply with the tag policies, the tag fails to be added.

A tag consists of a tag key and a tag value. Table 1 lists the tag key and value requirements.

Table 1 Tag key and value requirements

Parameter

Requirements

Tag key
  • Cannot be left blank.
  • Must be unique for the same instance.
  • Can contain 1 to 128 characters.
  • Can contain letters, digits, spaces, and special characters _.:=+-@
  • Cannot start or end with a space.
  • Cannot start with _sys_.

Tag value
  • Can contain 0 to 255 characters.
  • Can contain letters, digits, spaces, and special characters _.:=+-@
  • Cannot start or end with a space in instance creation.

Notes and Constraints

Up to 20 tags can be added to a Kafka instance.

Configuring Tags for a Kafka Instance

  1. Log in to the Kafka console.
  2. Click in the upper left corner to select the region where your instance is located.
  3. Configure Kafka instance tags in either of the following ways:

    Method 1:

    1. Click an instance name to go to the instance details page.
    2. In the navigation pane, choose Instance > Tags.
    3. Click Edit Tag.
    4. Add, edit, or delete tags as required.
      Table 2 Tag operations

      Operation

      Procedure

      Adding a tag
      1. Click Add Tag to set tags with Tag key and Tag value. If you have predefined tags, select a predefined pair of tag key and value, and click Add.

        A maximum of 20 tags can be added.

      2. Click OK.

        View the new tag on the tag list page.

      Editing a tag

      Modify the tag key and value, and click OK.

      On the tag list page, view the new tag key and value.

      Deleting a tag

      In the row containing the tag to be deleted, click Delete. Then, click OK to delete the tag.

      The tags are deleted when they are no longer displayed in the tag list.

    Method 2:

    1. In the row containing the desired Kafka instance, choose More > Edit Tag.
    2. Add, edit, or delete tags as required.
      Table 3 Tag operations

      Operation

      Procedure

      Adding a tag
      1. Click Add Tag to set tags with Tag key and Tag value. If you have predefined tags, select a predefined pair of tag key and value, and click Add.

        A maximum of 20 tags can be added.

      2. Click OK.
      3. In the row containing the Kafka instance with added tags, choose More > Edit Tag. View the added tags.

      Editing a tag
      1. Modify the tag key and value, and click OK.
      2. In the row containing the Kafka instance with edited tags, choose More > Edit Tag. View the edited tag key and value.

      Deleting a tag
      1. In the row containing the tag to be deleted, click Delete. Then, click OK to delete the tag.
      2. In the row containing the Kafka instance whose tags were deleted, choose More > Edit Tag. The tags are deleted when they are no longer displayed.

Related Document

To add or delete Kafka instance tags by calling an API, Batch Adding or Deleting Tags.

Parent Topic: Managing Instances