This article describes how to retrieve the ActiveMQ Runtime Configuration Data (activemq.xml file elements) using the REST API.
Endpoint
GET /activemq/managers/{nodeName}/{managerName}/runtime-configuration
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
nodeName |
string | Yes | Name of the ActiveMQ node. |
managerName |
string | Yes | Name of the ActiveMQ manager whose runtime configuration is retrieved. |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
validateAccessForUser |
string | No | Validates endpoint access for the specified user. |
Example Request
curl -X 'GET' \ 'http://localhost:8019/rest/v1/activemq/managers/MIDDLEWARE4_ACTIVEMQ/ActiveMQ16-1/runtime-configuration' \ -H 'accept: application/json' \ -H 'Authorization: Basic <base64-encoded-credentials>'
Request URL
http://localhost:8019/rest/v1/activemq/managers/MIDDLEWARE4_ACTIVEMQ/ActiveMQ16-1/runtime-configuration
Response Codes
| Status Code | Description |
|---|---|
| 200 | Returns matching object. |
| 400 | Error: Bad Request |
Example Response
- Success Response (200 OK): Returns the runtime configuration details of the specified ActiveMQ manager.
{
"fileHash": -1058628877,
"destinationPolicies": [
{
"type": "topic",
"name": ">",
"pendingMessageLimitStrategy": {
"name": "constantPendingMessageLimitStrategy",
"attributes": {
"limit": "1000"
}
}
}
],
"authorizationEntries": [
{
"type": "queue",
"name": ">",
"read": "ldapgroup",
"write": "admins,users,ldapgroup",
"admin": "ldapgroup"
},
{
"type": "topic",
"name": ">",
"read": "ldapgroup",
"write": "ldapgroup",
"admin": "ldapgroup"
},
{
"type": "topic",
"name": "ActiveMQ.Advisory.>",
"read": "ldapgroup",
"write": "ldapgroup",
"admin": "ldapgroup"
}
]
}| Field | Type | Description |
|---|---|---|
fileHash |
number | Hash value associated with the current runtime configuration. |
destinationPolicies |
array | Contains destination policy configurations for queues and topics. |
authorizationEntries |
array | Contains authorization rules configured for queues and topics. |
networkConnectors |
array | Contains network connector configurations used to connect ActiveMQ brokers. |
-
Example Error Response
(400-Error: Bad Request): Returns an error when the request is invalid or cannot be processed.
{
"type": "pcf",
"messageId": "WGS0024",
"message": "Object not read",
"explanation": "Problem on read object, check PCF code value.",
"action": "Resubmit request with a valid object.",
"code": "20301",
"codeStr": "EXIA_TEST_CMD_Q"
}