Help Center/ Distributed Message Service for RocketMQ/ API Reference/ APIs V2 (Recommended)/ Topic Management/ Querying the Topic Consumer Group List
Updated on 2022-09-14 GMT+08:00
View PDF

Querying the Topic Consumer Group List

Function

This API is used to query the topic consumer group list.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

instance_id

Yes

String

Instance ID.

topic

Yes

String

Topic name.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

groups

Array of strings

Consumer group list.

Example Requests

Query the topic consumer group list

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics/{topic}/groups

Example Responses

Status code: 200

Topic consumer group list queried successfully.

{
  "groups" : [ "CID_JODIE_1", "test_consumer" ]
}

Status Codes

Status Code

Description

200

Topic consumer group list queried successfully.

Error Codes

See Error Codes.

Parent topic: Topic Management