Updated on 2025-09-03 GMT+08:00

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 console.
  2. Click in the upper left corner to select the region where your instance is located.
  3. Click in the upper left corner and choose Application > Distributed Message Service for Kafka to open the Kafka instance list.
  4. Click the desired instance to go to the instance details page.
  5. In the navigation pane, choose Instance > Tags.
  6. Click Edit Tag.
  7. 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.