Updated on 2024-12-02 GMT+08:00

Querying the Kafka Consumer Group List

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

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 Application > 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, and Coordinator (ID) 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 consumer group, enter a consumer group name or status, Coordinator (ID), or keyword, then press Enter.
  7. (Optional) To refresh the consumer group list, click in the upper right corner.

Viewing the Consumer Group List (Kafka CLI)

  • For a Kafka instance with SASL 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 Basic Information 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 SASL 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 

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

      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]#