Help Center/ Distributed Message Service for Kafka/ User Guide/ Managing Consumer Groups/ Querying the Kafka Consumer Group List
Updated on 2025-08-21 GMT+08:00
View PDF
Share

Querying the Kafka Consumer Group List

After a consumer group is created, you can view its configuration and status.

Viewing the Consumer Group List

A consumer group list can be viewed on the Kafka console or on a client.

  1. Log in to the Kafka console.
  2. Click in the upper left corner to select the region where your instance is located.
  3. Click the desired instance to go to the instance details page.
  4. In the navigation pane, choose Instance > Consumer Groups.

    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

  5. (Optional) To query a consumer group, enter a consumer group name or status, Coordinator (ID), number of accumulated messages, description, or keyword, then press Enter.
  6. (Optional) To refresh the consumer group list, click in the upper right corner.
  • For a Kafka instance with ciphertext access disabled, run the following command in the /bin directory of the Kafka client: 
    ./kafka-consumer-groups.sh --bootstrap-server {connection-address} --list

    Parameter description: connection-address indicates the Kafka instance address, which can be obtained in the Connection area on the Overview page on the Kafka console.

    Example:

    [root@ecs-kafka bin]# ./kafka-consumer-groups.sh --bootstrap-server 192.168.xx.xx:9092,192.xx.xx.212:9092,192.xx.xx.147:9092 --list
test
__consumer-group-dial-test
[root@ecs-kafka bin]#
  • For a Kafka instance with ciphertext access enabled, do as follows:
    1. (Optional) If the username and password, and the SSL certificate has been configured, skip this step and go to 2. Otherwise, do as follows:

      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 /bin directory of the Kafka client: 
      ./kafka-consumer-groups.sh --bootstrap-server {connection-address} --list --command-config ../config/{ssl-user-config.properties}
      Table 1 Consumer group list query parameters

      Parameter

      Description

      connection-address

      Connection address of a Kafka instance. To obtain the address, choose Overview > Connection.

      ssl-user-config.properties

      Configuration file name. This file contains username, password, and SSL certificate information.

      Example:

      [root@ecs-kafka bin]# ./kafka-consumer-groups.sh --bootstrap-server 192.168.xx.xx:9093,192.168.xx.xx:9093,192.168.xx.xx:9093 --list --command-config ../config/ssl-user-config.properties
test
__consumer-group-dial-test
[root@ecs-kafka bin]#

Related Document

To view a consumer group list by calling an API, see Querying All Consumer Groups.

Parent Topic: Managing Consumer Groups