Querying the Consumer Group List or Details
Function
This API is used to query the consumer group list or details.
URI
GET /v2/{project_id}/instances/{instance_id}/groups/{group}/topics
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. |
|
instance_id |
Yes |
String |
Instance ID. |
|
group |
Yes |
String |
Consumer group name. |
|
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. |
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
topics |
Array of strings |
Topic list. |
Example Requests
Querying the consumer group list or details
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups/{group}/topics
Example Responses
Status code: 200
Consumer group list or details queried successfully.
{
"topics" : [ "topic01", "topic02" ]
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Consumer group list or details 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.
