Querying All Consumer Groups

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

View PDF

This API is used to query all consumer groups.

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

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	String	Offset, which is the position where the query starts. The value must be greater than or equal to 0.
limit	No	String	Maximum number of consumer group IDs returned in the current query. The default value is 10. The value ranges from 1 to 50.
group	No	String	Filter consumer group names that contain specific keywords.

None

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
group_ids	Array of strings	All consumer group IDs.
total	Integer	Total number of consumer groups.
next_offset	Integer	Sequence number of the next consumer group.
previous_offset	Integer	Sequence number of the previous consumer group.

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups?offest={offest}&limit={limit}&group={group}

Status code: 200

All consumer groups are queried successfully.

{
  "group_ids" : [ "groupId_1", "groupId_2", "groupId_3" ],
  "total" : 5,
  "next_offset" : 4,
  "previous_offset" : 0
}

Status Code	Description
200	All consumer groups are queried successfully.

Parent topic: Instance 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