Help Center> Distributed Message Service for Kafka> User Guide> Managing Consumer Groups> Querying the Kafka Consumer Group List
Updated on 2024-05-24 GMT+08:00
View PDF

Querying the Kafka Consumer Group List

This section describes how to query the consumer group list.

Viewing the Consumer Group List (Console)

  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 desired Kafka instance to view its details.
  5. In the navigation pane, choose the Consumer Groups tab.

    The consumer group name, status, Coordinator (ID), and description are displayed. Coordinator (ID) indicates the broker where the coordinator component is located. The consumer group status can be:

    • DEAD: The consumer group has no member or metadata.
    • EMPTY: The consumer group has metadata but has no member.
    • PREPARING_REBALANCE: The consumer group is to be rebalanced.
    • COMPLETING_REBALANCE: All members have joined the consumer group.
    • STABLE: Members in the consumer group can consume messages normally.
    Figure 1 Consumer group list

  6. (Optional) To query a specific consumer group, enter the consumer group name in the search box and click .
  7. (Optional) To refresh the consumer group list, click in the upper right corner.

Viewing the Consumer Group List (Kafka CLI)

  • If ciphertext access is not enabled for the Kafka instance, run the following command in the /{directory where the CLI is located}/kafka_{version}/bin/ directory to query the consumer group list:
    ./kafka-consumer-groups.sh --bootstrap-server {broker_ip}:{port} --list
  • If ciphertext access has been enabled for the Kafka instance, perform the following steps to query the consumer group list:
    1. (Optional) If the username and password, and the SSL certificate configuration has been set, skip this step. Otherwise, perform the following operations:

      Create the ssl-user-config.properties file in the /config directory of the Kafka client. Add the username and password, and the SSL certificate configuration by referring to 3.

    2. Run the following command in the /{directory where the CLI is located}/kafka_{version}/bin/ directory to query the consumer group list:
      ./kafka-consumer-groups.sh --bootstrap-server {broker_ip}:{port} --list --command-config ./config/ssl-user-config.properties
Parent topic: Managing Consumer Groups