This article shows how to search for ActiveMQ consumers using the REST API.
Search ActiveMQ Consumers
GET /activemq/consumers
Retrieves details of ActiveMQ consumers that match the specified search criteria.
Example Request
curl -X 'GET' \ 'http://<hostname>:8019/rest/v1/activemq/consumers?nodeName=CMACTIVEMQ&managerName=Activemq-server&brokerName=DemoBroker&consumerName=NOTSET%3A0%3A-1' \ -H 'accept: application/json' \ -H 'Authorization: Basic QWRtaW46YWRtaW4='
Query Parameters
| Parameter | Type | Description |
|---|---|---|
nodeName |
string (query) | Wildcard node name for search. |
managerName |
string (query) | Wildcard manager name for search. |
brokerName |
string (query) | Wildcard ActiveMQ broker name for search. |
consumerName |
string (query) | Wildcard ActiveMQ consumer name for search. |
projects |
string (query) | Comma-separated list of project IDs for filtering. |
filter |
string (query) | Filter by attributes in the format `{any |
order |
string (query) | Order results by attributes (`{attribute}:[asc |
limit |
integer (query) | Limit of found objects. |
attributes |
string (query) | Comma-separated list of attributes or sections to retrieve. |
validateAccessForUser |
string (query) | Validate endpoint access for user. |
Response Codes
200 OK – Returns the list of matching ActiveMQ consumers.
* – Returns
ErrorPojoin case of invalid parameters or server error.
Example Response
200 OK: Returns the list of matching ActiveMQ consumers.
[
{
"wgsName": "MQM",
"nodeName": "CMACTIVEMQ",
"managerName": "Activemq-server",
"brokerName": "DemoBroker",
"consumerName": "NOTSET:0:-1"
}
]