Updated on 2024-10-10 GMT+08:00

Configuring Kafka Instance Tags

Tags facilitate Kafka instance identification and management.

You can add tags to a Kafka instance when creating the instance or add tags on the Tags tab page of the created instance. Up to 20 tags can be added to an instance. Tags can be deleted.

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 on the Tags page 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.

Procedure

  1. Log in to the console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

  3. Click and choose Middleware > Distributed Message Service (for Kafka) to open the console of DMS for Kafka.
  4. Click the name of an instance.
  5. In the navigation pane on the left, choose Tags.

    View the tags of the instance.

  6. Perform the following operations as required:

    • Add a tag
      1. Click Create/Delete Tag.
      2. Enter a tag key and a tag value, and click Add.

        If you have predefined tags, select a predefined pair of tag key and value, and click Add.

      3. Click OK.
    • Delete a tag

      Delete a tag using either of the following methods:

      • In the row containing the tag to be deleted, click Delete. In the Delete Tag dialog box, click Yes.
      • Click Create/Delete Tag. In the dialog box that is displayed, click next to the tag to be deleted and click OK.