Querying the Consumer Group List or Details

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

View PDF

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

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

**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.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
topic	No	String	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.

None

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
topics	Array of strings	Topic list.

Querying the consumer group list or details

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

Status code: 200

Consumer group list or details queried successfully.

{
  "topics" : [ "topic01", "topic02" ]
}

Status Code	Description
200	Consumer group list or details 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