Querying a Consumer Group
Function
This API is used to query details about a specified consumer group.
URI
GET /v2/{project_id}/instances/{instance_id}/groups/{group}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
instance_id |
Yes |
String |
Instance ID. |
group |
Yes |
String |
Consumer group name. |
Request Parameters
None
Response Parameters
Status code: 200
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. |
Example Requests
Querying a consumer group
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups/{group}
Example Responses
Status code: 200
Consumer group queried successfully.
{ "enabled" : true, "broadcast" : false, "brokers" : [ "broker-0" ], "retry_max_time" : 16, "from_beginning" : false }
Status Codes
Status Code |
Description |
---|---|
200 |
Consumer group queried successfully. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.