Querying the Topic Consumer Group List

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

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	String	Definition Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body. Constraints N/A Range N/A Default Value N/A
topic	Yes	String	Definition Topic name. Constraints N/A Range N/A Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Definition Number of returned consumer groups of a query. Constraints N/A Range 1–50 Default Value 10
offset	No	Integer	Definition Offset where the query starts. Constraints N/A Range ≥ 0 Default Value 0

None

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
groups	Array of strings	Definition Consumer group list. Constraints N/A Range N/A Default Value N/A
total	Integer	Definition Total number of topics. Constraints N/A Range N/A Default Value N/A

Querying the consumer group list of a specified topic

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

Status code: 200

Topic consumer group list queried successfully.

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

Status Code	Description
200	Topic consumer group list queried successfully.

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.