Querying the Topic Consumer Group List
Function
This API is used to query the topic consumer group list.
URI
GET /v2/{project_id}/instances/{instance_id}/topics/{topic}/groups
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Project ID. For details, see Obtaining a Project ID. |
instance_id | Yes | String | Instance ID. |
topic | Yes | String | Topic name. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
limit | No | Integer | Maximum number of records returned in the current query. The default value is 10. The value ranges from 1 to 50. |
offset | No | Integer | Offset, which is the position where the query starts. The value must be greater than or equal to 0. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter | Type | Description |
---|---|---|
groups | Array of strings | Consumer group list. |
Example Requests
Querying the consumer group list of a specified topic
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics/{topic}/groups
Example Responses
Status code: 200
Topic consumer group list queried successfully.
{"groups" : [ "CID_JODIE_1", "test_consumer" ]}
Status Codes
Status Code | Description |
---|---|
200 | Topic consumer group list queried successfully. |
Error Codes
See Error Codes.
- URI