Querying a Consumer Group

Updated on 2022-09-14 GMT+08:00

View PDF

This API is used to query details about a specified consumer group.

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
instance_id	Yes	String	Instance ID.
group	Yes	String	Consumer group name.

None

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
enabled	Boolean	Enabled or not.
broadcast	Boolean	Whether to broadcast.
brokers	Array of strings	List of associated brokers.
name	String	Consumer group name.
retry_max_time	Number	Maximum number of retries.
from_beginning	Boolean	Whether consumption starts from the beginning.

Querying a consumer group

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

Status code: 200

Consumer group queried successfully.

{
  "enabled" : true,
  "broadcast" : false,
  "brokers" : [ "broker-0" ],
  "retry_max_time" : 16,
  "from_beginning" : false
}

Status Code	Description
200	Consumer group queried successfully.

Parent topic: Consumer Group Management

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

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel