Updated on 2025-06-20 GMT+08:00

Querying the Consumer Group List or Details

Function

This API is used to query the consumer group list or details.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/instances/{instance_id}/groups/{group}/topics

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Parameter description:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

instance_id

Yes

String

Parameter description:

Instance ID. To obtain it, log in to the RocketMQ console and find the instance ID on the RocketMQ instance details page.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

group

Yes

String

Parameter description:

Consumer group name.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

topic

No

String

Parameter description:

Topic to be queried. If this parameter is not specified, the entire topic list is queried. If this parameter is specified, details of the topic are queried.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

limit

No

Integer

Parameter description:

Maximum number of topics that can be returned in a query.

Constraints:

N/A

Value range:

1–50

Default value:

10

offset

No

Integer

Parameter description:

Offset where the query starts.

Constraints:

N/A

Value range:

≥ 0

Default value:

0

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

topics

Array of strings

Parameter description:

Topic list. This parameter is displayed only when you query the topic consumption list.

total

Integer

Parameter description:

Total number of topics. This parameter is displayed only when you query the topic consumption list.

Value range:

N/A

lag

Long

Parameter description:

Total number of accumulated messages.

Value range:

N/A

max_offset

Long

Parameter description:

Total number of messages.

Value range:

N/A

consumer_offset

Long

Parameter description:

Number of consumed messages.

Value range:

N/A

brokers

Array of Brokers objects

Parameter description:

Associated brokers of topics. This parameter is displayed only when you query the topic consumption details.

Table 4 Brokers

Parameter

Type

Description

broker_name

String

Parameter description:

Names of the associated brokers.

Value range:

N/A

queues

Array of Queue objects

Parameter description:

Queue details of the associated brokers.

Table 5 Queue

Parameter

Type

Description

id

Integer

Parameter description:

Queue ID.

Value range:

N/A

lag

Long

Parameter description:

Total number of accumulated messages in the queue.

Value range:

N/A

broker_offset

Long

Parameter description:

Total number of messages in the queue.

Value range:

N/A

consumer_offset

Long

Parameter description:

Number of consumed messages.

Value range:

N/A

last_message_time

Long

Parameter description:

Time (UNIX, in millisecond) when the latest consumed message was stored.

Value range:

N/A

Example Requests

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups/{group}/topics?topic=test0001

Example Responses

Status code: 200

Consumer group list or details queried successfully.

  • Successful

    {
      "topics" : [ "topic-test" ],
      "total" : 1
    }
  • Consumer group details are queried successfully.

    {
      "lag" : 0,
      "max_offset" : 1,
      "consumer_offset" : 1,
      "brokers" : [ {
        "broker_name" : "broker-0",
        "queues" : [ {
          "id" : 0,
          "lag" : 0,
          "broker_offset" : 0,
          "consumer_offset" : 0,
          "last_message_time" : 0
        }, {
          "id" : 1,
          "lag" : 0,
          "broker_offset" : 1,
          "consumer_offset" : 1,
          "last_message_time" : 1679398537088
        }, {
          "id" : 0,
          "lag" : 0,
          "broker_offset" : 0,
          "consumer_offset" : 0,
          "last_message_time" : 0
        } ]
      } ]
    }

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.rocketmq.v2.region.RocketMQRegion;
import com.huaweicloud.sdk.rocketmq.v2.*;
import com.huaweicloud.sdk.rocketmq.v2.model.*;


public class ShowConsumerListOrDetailsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        RocketMQClient client = RocketMQClient.newBuilder()
                .withCredential(auth)
                .withRegion(RocketMQRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowConsumerListOrDetailsRequest request = new ShowConsumerListOrDetailsRequest();
        request.withInstanceId("{instance_id}");
        request.withGroup("{group}");
        try {
            ShowConsumerListOrDetailsResponse response = client.showConsumerListOrDetails(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkrocketmq.v2.region.rocketmq_region import RocketMQRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkrocketmq.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = RocketMQClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(RocketMQRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowConsumerListOrDetailsRequest()
        request.instance_id = "{instance_id}"
        request.group = "{group}"
        response = client.show_consumer_list_or_details(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    rocketmq "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := rocketmq.NewRocketMQClient(
        rocketmq.RocketMQClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowConsumerListOrDetailsRequest{}
	request.InstanceId = "{instance_id}"
	request.Group = "{group}"
	response, err := client.ShowConsumerListOrDetails(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Consumer group list or details queried successfully.

Error Codes

See Error Codes.