Help Center/ Distributed Message Service for RocketMQ/ User Guide/ Managing Instances/ Configuring Tags for a RocketMQ Instance
Updated on 2026-04-30 GMT+08:00
View PDF

Configuring Tags for a RocketMQ Instance

Tags facilitate RocketMQ instance identification and management.

You can add tags to a RocketMQ instance when creating the instance or add tags on the Tags tab page of the created instance. You can also delete tags that are no longer used.

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

Requirement

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

A maximum of 20 tags can be added.

Prerequisite

A RocketMQ instance has been purchased.

Configuring Tags for a RocketMQ Instance

  1. Log in to the RocketMQ console.
  2. Click a RocketMQ instance name to go to the instance overview page.
  3. In the navigation pane, choose Instance > Tags.
  4. Click Edit Tag.
  5. Add, edit, or delete tags as required.

    Table 2 Tag operations

    Operation

    Procedure

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

      A maximum of 20 tags can be added.

    2. Click OK.

      View the new tag on the Edit Tag or tag list page.

    Editing a tag

    Modify the tag key and value, and click OK.

    View the edited tag on the Edit Tag or tag list page.

    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 on the Edit Tag page and tag list.

Filtering Instances by Tag

  1. Log in to the RocketMQ console.
  2. On the instance list page, click the search box and select the tag key and tag value.

    The operators include is equal to =, is not equal to !=, contains :, and does not contain !=. You can set exact or fuzzy search.

    Only the instances with the tags are displayed in the list.

Related Document

Parent Topic: Managing Instances