| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.1//EN" "http://www.w3.org/TR/xhtml-basic/xhtml-basic11.dtd"> |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| Architecture |
| --> |
| <html lang="en"> |
| <head> |
| <meta content="text/html; charset=utf-8" http-equiv="Content-Type"/> |
| <meta content="ActiveMQ's next generation of messaging" name="description"/> |
| <meta content="messaging,stomp,jms,activemq,apollo" name="keywords"/> |
| <meta content="Apollo" name="author"/> |
| <script src="../scripts/jquery.js"></script> |
| <link type="text/css" rel="stylesheet" href="../styles/impact/css/pygmentize.css"/> |
| <link type="text/css" rel="stylesheet" href="../styles/impact/css/site.css"/> |
| <style type='text/css'> |
| /* <![CDATA[ */ |
| table.reference tr th { |
| text-align:left; |
| } |
| tr.even { |
| background-color: #eee; |
| } |
| table.reference tr td { |
| text-align:left; |
| padding: .4em; |
| vertical-align:top; |
| font-size:90%; |
| } |
| table.reference tr td p { |
| margin: 0 0 .5em 0; |
| } |
| td.methods { |
| font-weight:bold; |
| } |
| /* ]]> */ |
| </style> |
| |
| <title></title> |
| </head> |
| <body> |
| <div id="navigation"> |
| <div class="wrapper"> |
| <ul> |
| <li><a href="../index.html">Apollo 1.7.1</a></li> |
| <li><a href="../community/developers.html">Developers</a></li> |
| <li><a href="../community/index.html">Community</a></li> |
| <li><a href="../download.html">Download</a></li> |
| </ul> <div></div> |
| </div> |
| </div> |
| <div id="content"> |
| <div class="wrapper"> |
| <h1 id = "Apollo_1_7_1_Management_API">Apollo 1.7.1 Management API</h1> |
| |
| <p><div class="toc"><ul style="list-style:none;"> |
| <li><a href="#Overview">Overview</a></li> |
| <li><ul style="list-style:none;"> |
| <li><a href="#Authentication">Authentication</a></li> |
| <li><a href="#JSON_Representation">JSON Representation</a></li> |
| <li><a href="#Response_Codes">Response Codes</a></li> |
| <li><a href="#Working_with_Tabular_Results">Working with Tabular Results</a></li> |
| </ul></li> |
| <li><a href="#Route_Reference">Route Reference</a></li> |
| <li><ul style="list-style:none;"> |
| <li><a href="#Broker_Management">Broker Management</a></li> |
| <li><a href="#Virtual_Host_Management">Virtual Host Management</a></li> |
| <li><a href="#Connection_Management">Connection Management</a></li> |
| <li><a href="#Broker_Configuration_Management">Broker Configuration Management</a></li> |
| <li><a href="#Session_Management">Session Management</a></li> |
| </ul></li> |
| </ul></div></p> |
| |
| <h2 id = "Overview">Overview</h2> |
| |
| <p>Apollo's REST API runs on port 61680 or via SSL on port 61681. If your |
| running an Apollo broker on your local machine, you could access the |
| API at the following HTTP URLs:</p> |
| |
| <pre><code>http://localhost:61680 |
| https://localhost:61681</code></pre> |
| |
| <p>For all of the rest of this document, we will be leaving off that part, |
| since it is the same for every API call.</p> |
| |
| <h3 id = "Authentication">Authentication</h3> |
| |
| <p>The broker requires all requests against the management API to supply |
| user credentials which have administration privileges.</p> |
| |
| <p>The user credentials can be supplied using via HTTP basic |
| authentication. Example:</p> |
| |
| <pre><code>$ curl -u "admin:password" http://localhost:61680/broker</code></pre> |
| |
| <h3 id = "JSON_Representation">JSON Representation</h3> |
| |
| <p>The API routes are intended to be access programmatically as JSON |
| services but they also provide an HTML representation so that the API |
| services can easily be browsed using a standard web browser.</p> |
| |
| <p>You must either set the HTTP <code>Accept</code> header to <code>application/json</code> or |
| append <code>.json</code> to the URL to get the JSON representation of the data. |
| Example:</p> |
| |
| <pre><code>$ curl -H "Accept: application/json" -u "admin:password" \ |
| http://localhost:61680/broker |
| |
| $ curl -u "admin:password" http://localhost:61680/broker.json</code></pre> |
| |
| <h3 id = "Response_Codes">Response Codes</h3> |
| |
| <p>You can use the HTTP response code to determine if your request |
| succeeded or failed. Expect the following:</p> |
| |
| <ul> |
| <li><em><code>200</code></em>: If a GET, PUT, or DELETE request succeeds.</li> |
| <li><em><code>303</code></em>: If a POST request succeeds.</li> |
| <li><em><code>304</code></em>: If the resource cannot be modified at the current time.</li> |
| <li><em><code>400</code></em>: The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.</li> |
| <li><em><code>404</code></em>: If the resource cannot be found.</li> |
| <li><em><code>401</code></em>: If the user does not have access to the resource.</li> |
| <li><em><code>50x</code></em>: If an internal server error occurs while processing the request.</li> |
| </ul> |
| |
| <p>If your get a <em><code>40x</code></em> or <em><code>50x</code></em> response code, the response message |
| will contain a document describing the failure. For example, if we try |
| to use invalid query syntax you would get:</p> |
| |
| <pre><code>$ curl -i -u "admin:password" `echo 'http://localhost:61680/broker/virtual-hosts/apollo-01/queues.json?f=id&q=foo(id=="foo")'` |
| HTTP/1.1 400 Bad Request |
| Content-Type: application/json |
| Transfer-Encoding: chunked |
| |
| {"message":"Unable to find function (method): \"foo(java.lang.Boolean)\" in any user-defined function handlers or the default function handler"}</code></pre> |
| |
| <h3 id = "Working_with_Tabular_Results">Working with Tabular Results</h3> |
| |
| <p>Many of the resource routes provided by the broker implement |
| a selectable paged tabular interface. A good example of such |
| a resource route is the connections list. It's route is:</p> |
| |
| <pre><code>/broker/connections</code></pre> |
| |
| <p>Example:</p> |
| |
| <pre><code>$ curl -u "admin:password" \ |
| 'http://localhost:61680/broker/connections.json'</code></pre> |
| |
| <p>Results in a <a href="./api/apollo-dto/org/apache/activemq/apollo/dto/DataPageDTO.html">Data Page</a> :</p> |
| |
| <div class="syntax"><pre name='code' class='brush: js; gutter: false;'><code> |
| { |
| "page":0, |
| "page_size":100, |
| "total_pages":1, |
| "total_rows":2, |
| "headers":[ |
| "*" |
| ], |
| "rows":[ |
| { |
| "id":"4", |
| "state":"STARTED", |
| "state_since":1306848325102, |
| "read_counter":103, |
| "write_counter":239110628, |
| "connector":"tcp", |
| "protocol":"stomp", |
| "remote_address":"/127.0.0.1:61775", |
| "protocol_version":"1.0", |
| "user":"admin", |
| "waiting_on":"client request", |
| "subscription_count":1 |
| }, |
| { |
| "id":"5", |
| "state":"STARTED", |
| "state_since":1306848325102, |
| "read_counter":227739229, |
| "write_counter":113, |
| "connector:"tcp", |
| "protocol":"stomp", |
| "remote_address":"/127.0.0.1:61776", |
| "protocol_version":"1.0", |
| "user":"admin", |
| "waiting_on":"blocked sending to: org.apache.activemq.apollo.broker.Queue$$anon$1@13765e9b", |
| "subscription_count":0 |
| } |
| ] |
| } |
| </code></pre></div> |
| |
| <p>The <code>*</code> header field means the record was selected. To narrow down the selected fields you can add |
| multiple <code>f</code> query parameters to pick the fields you want to retrieve.</p> |
| |
| <p>Example:</p> |
| |
| <pre><code>$ curl -u "admin:password" \ |
| 'http://localhost:61680/broker/connections.json?f=id&f=read_counter'</code></pre> |
| |
| <p>Results in :</p> |
| |
| <div class="syntax"><pre name='code' class='brush: js; gutter: false;'><code> |
| { |
| "page":0, |
| "page_size":100, |
| "total_pages":1, |
| "total_rows":2, |
| "headers":[ |
| "id", |
| "read_counter" |
| ], |
| "rows":[ |
| [ |
| "7", |
| 110733109 |
| ], |
| [ |
| "6", |
| 103 |
| ] |
| ] |
| } |
| </code></pre></div> |
| |
| <p>If you want to narrow down the records which get selected, you can set a <code>q</code> |
| query parameter to SQL 92 style where clause which uses the record's fields |
| to filter down the selected records.</p> |
| |
| <p>For example to only view local connection, you would want to use a where |
| clause like <code>remote_address LIKE "/127.0.0.01:%"</code> which to execute with |
| <code>curl</code> you would run:</p> |
| |
| <pre><code>curl -u "admin:password" \ |
| 'http://localhost:61680/broker/connections.json?q=remote_address%20LIKE%20"/127.0.0.1:%"'</code></pre> |
| |
| <p>The records are paged. The default page size is 100, so only the first 100 |
| records will be displayed. If you want to view subsequent results, you must |
| set the <code>p</code> query parameter to the page you wish to access. You can change |
| the page size by setting the <code>ps</code> query parameter.</p> |
| |
| <p>The results are typically return in the order in which the records were original |
| created. If you want to retrieve them in a different order, use the <code>o</code> query |
| parameter to define the order in which they are returned. Example:</p> |
| |
| <pre><code>curl -u "admin:password" \ |
| 'http://localhost:61680/broker/connections.json?o=write_counter%20DESC&o=id'</code></pre> |
| |
| <h2 id = "Route_Reference">Route Reference</h2> |
| |
| <h3 id = "Broker_Management">Broker Management</h3> |
| |
| <table class="reference"> |
| <tr> |
| <th></th> |
| <th>Route</th> |
| <th>On Success</th> |
| </tr> |
| <tr class="even"> |
| <td class="methods" rowspan="2"> |
| <code> |
| POST |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/action/shutdown.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 303 |
| </code> |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="description" colspan="2"> |
| <p>Shuts down the JVM.</p> |
| |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| <and></and> |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/BrokerStatusDTO.html"> |
| BrokerStatusDTO |
| </a> |
| </code> |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="description" colspan="2"> |
| <p>General information about the broker, JVM, and OS status. Example: </p> |
| |
| <p><code>curl -u "admin:password" http://localhost:61680/broker.json</code></p> |
| |
| <div class="syntax"><pre name='code' class='brush: js; gutter: false;'><code> |
| { |
| "id": "default", |
| "state": "STARTED", |
| "state_since": 1314573353753, |
| "version": "1.7.1", |
| "jvm_metrics": { |
| "heap_memory": { |
| "used": 22165160, |
| "alloc": 162201600, |
| "max": 954466304 |
| }, |
| "non_heap_memory": { |
| "used": 44522128, |
| "alloc": 45944832, |
| "max": 136314880 |
| }, |
| "classes_loaded": 5776, |
| "classes_unloaded": 0, |
| "threads_current": 21, |
| "threads_peak": 22, |
| "os_arch": "x86_64", |
| "os_name": "Mac OS X 10.7", |
| "os_memory_total": 8589934592, |
| "os_memory_free": 3339231232, |
| "os_swap_total": 0, |
| "os_swap_free": 2147483648, |
| "os_fd_open": 111, |
| "os_fd_max": 10240, |
| "os_load_average": 0.99267578125, |
| "os_cpu_time": 5630000000, |
| "os_processors": 4, |
| "runtime_name": "86739@chirino-mbp.local", |
| "jvm_name": "Java HotSpot(TM) 64-Bit Server VM 1.6.0_26 (Apple Inc.)", |
| "uptime": 37761, |
| "start_time": 1314573351000 |
| }, |
| "current_time": 1314573388707, |
| "virtual_hosts": ["default"], |
| "connectors": ["tls", "tcp"], |
| "connection_counter": 0 |
| } |
| </code></pre></div> |
| |
| <p>You can the <code>?connections=true</code> query parameter to have a list of connections |
| included n the result.</p> |
| |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/queue-metrics.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| <and></and> |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/AggregateDestMetricsDTO.html"> |
| AggregateDestMetricsDTO |
| </a> |
| </code> |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="description" colspan="2"> |
| <p>Aggregates the messaging metrics for all the queue destinations. Example:</p> |
| |
| <p><code>curl -u "admin:password" http://localhost:61680/broker/queue-metrics.json</code></p> |
| |
| <div class="syntax"><pre name='code' class='brush: js; gutter: false;'><code> |
| { |
| "current_time": 1314573698381, |
| "enqueue_item_counter": 57343, |
| "enqueue_size_counter": 63128582, |
| "enqueue_ts": 1314573698478, |
| "dequeue_item_counter": 55121, |
| "dequeue_size_counter": 60681503, |
| "dequeue_ts": 1314573698478, |
| "producer_counter": 22, |
| "consumer_counter": 16, |
| "producer_count": 22, |
| "consumer_count": 16, |
| "expired_item_counter": 0, |
| "expired_size_counter": 0, |
| "expired_ts": 1314573695015, |
| "nack_item_counter": 0, |
| "nack_size_counter": 0, |
| "nack_ts": 1314573695015, |
| "queue_size": 2447079, |
| "queue_items": 2222, |
| "swapped_in_size_max": 5963776, |
| "swapped_in_size": 5278341, |
| "swapped_in_items": 4794, |
| "swapping_in_size": 0, |
| "swapping_out_size": 0, |
| "swap_out_item_counter": 60, |
| "swap_out_size_counter": 65931, |
| "swap_in_item_counter": 60, |
| "swap_in_size_counter": 65931, |
| "objects": 10 |
| } |
| </code></pre></div> |
| |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/topic-metrics.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| <and></and> |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/AggregateDestMetricsDTO.html"> |
| AggregateDestMetricsDTO |
| </a> |
| </code> |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="description" colspan="2"> |
| <p>Aggregates the messaging metrics for all the topic destinations</p> |
| |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/dsub-metrics.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| <and></and> |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/AggregateDestMetricsDTO.html"> |
| AggregateDestMetricsDTO |
| </a> |
| </code> |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="description" colspan="2"> |
| <p>Aggregates the messaging metrics for all the durable subscription destinations</p> |
| |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/dest-metrics.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| <and></and> |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/AggregateDestMetricsDTO.html"> |
| AggregateDestMetricsDTO |
| </a> |
| </code> |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="description" colspan="2"> |
| <p>Aggregates the messaging metrics for all the destinations</p> |
| |
| </td> |
| </tr> |
| </table> |
| |
| <div></div> |
| |
| <h3 id = "Virtual_Host_Management">Virtual Host Management</h3> |
| |
| <table class="reference"> |
| <tr> |
| <th></th> |
| <th>Route</th> |
| <th>On Success</th> |
| </tr> |
| <tr class="even"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/virtual-hosts.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| <and></and> |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/DataPageDTO.html"> |
| DataPageDTO |
| </a> |
| paging |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/VirtualHostStatusDTO.html"> |
| VirtualHostStatusDTO |
| </a> |
| <div></div> |
| </code> |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="description" colspan="2"> |
| <p>Provides tabular access to all the virtual hosts.</p> |
| |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/virtual-hosts/{host}.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| <and></and> |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/VirtualHostStatusDTO.html"> |
| VirtualHostStatusDTO |
| </a> |
| </code> |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="description" colspan="2"> |
| <p>General details about the <code>{host}</code> virtual host. Example: </p> |
| |
| <p><code>curl -u "admin:password" http://localhost:61680/broker/virtual-hosts/default.json</code></p> |
| |
| <div class="syntax"><pre name='code' class='brush: js; gutter: false;'><code> |
| { |
| "id": "default", |
| "state": "STARTED", |
| "state_since": 1314573798989, |
| "topics": [], |
| "queues": ["example-4", "example-7", "example-6", "example-0", |
| "example-3", "example-8", "example-1", "example-5", |
| "example-9", "example-2"], |
| "dsubs": [], |
| "store": true, |
| "host_names": ["default", "localhost", "127.0.0.1"] |
| } |
| </code></pre></div> |
| |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/virtual-hosts/{host}/queue-metrics.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| <and></and> |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/AggregateDestMetricsDTO.html"> |
| AggregateDestMetricsDTO |
| </a> |
| </code> |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="description" colspan="2"> |
| <p>Aggregates the messaging metrics for all the queue destinations on the |
| <code>{host}</code> virtual host.</p> |
| |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/virtual-hosts/{host}/topic-metrics.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| <and></and> |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/AggregateDestMetricsDTO.html"> |
| AggregateDestMetricsDTO |
| </a> |
| </code> |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="description" colspan="2"> |
| <p>Aggregates the messaging metrics for all the topic destinations on the |
| <code>{host}</code> virtual host.</p> |
| |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/virtual-hosts/{host}/dsub-metrics.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| <and></and> |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/AggregateDestMetricsDTO.html"> |
| AggregateDestMetricsDTO |
| </a> |
| </code> |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="description" colspan="2"> |
| <p>Aggregates the messaging metrics for all the durable subscription destinations on the |
| <code>{host}</code> virtual host.</p> |
| |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/virtual-hosts/{host}/dest-metrics.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| <and></and> |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/AggregateDestMetricsDTO.html"> |
| AggregateDestMetricsDTO |
| </a> |
| </code> |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="description" colspan="2"> |
| <p>Aggregates the messaging metrics for all the destinations on the |
| <code>{host}</code> virtual host.</p> |
| |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/virtual-hosts/{host}/store.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| <and></and> |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/StoreStatusDTO.html"> |
| StoreStatusDTO |
| </a> |
| sub class (depends on the store implementation) |
| </code> |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="description" colspan="2"> |
| <p>Gets metrics about the status of the message store used by the <code>{host}</code> virtual host. Example:</p> |
| |
| <p><code>curl -u "admin:password" http://localhost:61680/broker/virtual-hosts/default/store.json</code></p> |
| |
| <div class="syntax"><pre name='code' class='brush: js; gutter: false;'><code> |
| { |
| "@class": "bdb_store_status", |
| "id": "bdb store at /Users/chirino/opt/default/data", |
| "state": "STARTED", |
| "state_since": 1314573798939, |
| "canceled_message_counter": 0, |
| "flushed_message_counter": 581034, |
| "canceled_enqueue_counter": 0, |
| "flushed_enqueue_counter": 581034, |
| "message_load_latency": { |
| "count": 0, |
| "total": 0, |
| "max": 0, |
| "min": 0 |
| }, |
| "flush_latency": { |
| "count": 0, |
| "total": 0, |
| "max": 0, |
| "min": 0 |
| }, |
| "pending_stores": 0, |
| "message_load_batch_size": { |
| "count": 0, |
| "total": 0, |
| "max": -2147483648, |
| "min": 2147483647 |
| } |
| } |
| </code></pre></div> |
| |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/virtual-hosts/{host}/queues.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| <and></and> |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/DataPageDTO.html"> |
| DataPageDTO |
| </a> |
| paging |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/QueueStatusDTO.html"> |
| QueueStatusDTO |
| </a> |
| <div></div> |
| </code> |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="description" colspan="2"> |
| <p>Provides tabular access to all queue destinations on the <code>{host}</code> virtual host.</p> |
| |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/virtual-hosts/{host}/queues/{dest}.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| <and></and> |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/QueueStatusDTO.html"> |
| QueueStatusDTO |
| </a> |
| </code> |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="description" colspan="2"> |
| <p>Gets metrics and details about the <code>{dest}</code> queue on the <code>{host}</code> virtual host. Example:</p> |
| |
| <p>You can the <code>?producers=true</code> query parameter to have a list of producers |
| included n the result. |
| You can the <code>?consumers=true</code> query parameter to have a list of consumers |
| included n the result.</p> |
| |
| <p><code>curl -u "admin:password" http://localhost:61680/broker/virtual-hosts/default/queues/example-5.json?producers=true&consumers=true</code></p> |
| |
| <div class="syntax"><pre name='code' class='brush: js; gutter: false;'><code> |
| { |
| "id": "example-5", |
| "state": "STARTED", |
| "state_since": 1314573814532, |
| "config": { |
| "other": [] |
| }, |
| "binding": { |
| "@class": "queue_destination", |
| "path": ["example-5"] |
| }, |
| "metrics": { |
| "current_time": 1314574273342, |
| "enqueue_item_counter": 878638, |
| "enqueue_size_counter": 975430031, |
| "enqueue_ts": 1314574273335, |
| "dequeue_item_counter": 878522, |
| "dequeue_size_counter": 975301271, |
| "dequeue_ts": 1314574273328, |
| "producer_counter": 4, |
| "consumer_counter": 4, |
| "producer_count": 2, |
| "consumer_count": 2, |
| "expired_item_counter": 0, |
| "expired_size_counter": 0, |
| "expired_ts": 1314573814488, |
| "nack_item_counter": 118, |
| "nack_size_counter": 131098, |
| "nack_ts": 1314573928240, |
| "queue_size": 128760, |
| "queue_items": 116, |
| "swapped_in_size_max": 688128, |
| "swapped_in_size": 688200, |
| "swapped_in_items": 620, |
| "swapping_in_size": 0, |
| "swapping_out_size": 0, |
| "swap_out_item_counter": 605, |
| "swap_out_size_counter": 671279, |
| "swap_in_item_counter": 605, |
| "swap_in_size_counter": 671279 |
| }, |
| "entries": [], |
| "producers": [{ |
| "kind": "connection", |
| "id": "43", |
| "label": "/127.0.0.1:51632", |
| "enqueue_item_counter": 12168, |
| "enqueue_size_counter": 13495374, |
| "enqueue_ts": 1314574273328 |
| }, |
| { |
| "kind": "connection", |
| "id": "76", |
| "label": "/127.0.0.1:51665", |
| "enqueue_item_counter": 13663, |
| "enqueue_size_counter": 15154824, |
| "enqueue_ts": 1314574273336 |
| }], |
| "consumers": [{ |
| "kind": "connection", |
| "id": "65", |
| "label": "/127.0.0.1:51654", |
| "enqueue_item_counter": 12678, |
| "enqueue_size_counter": 14060805, |
| "enqueue_ts": 1314574273248, |
| "position": 878615, |
| "acquired_count": 60, |
| "acquired_size": 66600, |
| "total_ack_count": 12618, |
| "total_nack_count": 0, |
| "waiting_on": "ack" |
| }, |
| { |
| "kind": "connection", |
| "id": "75", |
| "label": "/127.0.0.1:51664", |
| "enqueue_item_counter": 13397, |
| "enqueue_size_counter": 14860500, |
| "enqueue_ts": 1314574273248, |
| "position": 878639, |
| "acquired_count": 56, |
| "acquired_size": 62160, |
| "total_ack_count": 13341, |
| "total_nack_count": 0, |
| "waiting_on": "producer" |
| }] |
| } |
| </code></pre></div> |
| |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="methods" rowspan="2"> |
| <code> |
| DELETE |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/virtual-hosts/{host}/queues/{dest}.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| </code> |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="description" colspan="2"> |
| <p>Deletes the <code>{dest}</code> queue on the <code>{host}</code> virtual host.</p> |
| |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="methods" rowspan="2"> |
| <code> |
| PUT |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/virtual-hosts/{host}/queues/{dest}.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| </code> |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="description" colspan="2"> |
| <p>Creates the <code>{dest}</code> queue on the <code>{host}</code> virtual host.</p> |
| |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/virtual-hosts/{host}/topics.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| <and></and> |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/DataPageDTO.html"> |
| DataPageDTO |
| </a> |
| paging |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/TopicStatusDTO.html"> |
| TopicStatusDTO |
| </a> |
| <div></div> |
| </code> |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="description" colspan="2"> |
| <p>Provides tabular access to all topic destinations on the <code>{host}</code> virtual host.</p> |
| |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/virtual-hosts/{host}/topics/{dest}.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| <and></and> |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/TopicStatusDTO.html"> |
| TopicStatusDTO |
| </a> |
| </code> |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="description" colspan="2"> |
| <p>Gets metrics and details about the <code>{dest}</code> topic on the <code>{host}</code> virtual host. Example:</p> |
| |
| <p>You can the <code>?producers=true</code> query parameter to have a list of producers |
| included n the result. |
| You can the <code>?consumers=true</code> query parameter to have a list of consumers |
| included n the result.</p> |
| |
| <p><code>curl -u "admin:password" http://localhost:61680/broker/virtual-hosts/default/topics/example-2.json?producers=true&consumers=true</code></p> |
| |
| <div class="syntax"><pre name='code' class='brush: js; gutter: false;'><code> |
| { |
| "id": "example-2", |
| "state": "STARTED", |
| "state_since": 1314574398831, |
| "config": { |
| "other": [] |
| }, |
| "producers": [{ |
| "kind": "connection", |
| "id": "78", |
| "label": "/127.0.0.1:51668", |
| "enqueue_item_counter": 1133674, |
| "enqueue_size_counter": 1259289609, |
| "enqueue_ts": 1314574422110 |
| }], |
| "consumers": [{ |
| "kind": "connection", |
| "id": "86", |
| "label": "/127.0.0.1:51677", |
| "enqueue_item_counter": 566836, |
| "enqueue_size_counter": 629643696, |
| "enqueue_ts": 1314574422110 |
| }, |
| { |
| "kind": "connection", |
| "id": "82", |
| "label": "/127.0.0.1:51673", |
| "enqueue_item_counter": 566838, |
| "enqueue_size_counter": 629645913, |
| "enqueue_ts": 1314574422110 |
| }], |
| "dsubs": [], |
| "metrics": { |
| "current_time": 0, |
| "enqueue_item_counter": 1133674, |
| "enqueue_size_counter": 1259289609, |
| "enqueue_ts": 1314574422110, |
| "dequeue_item_counter": 1133674, |
| "dequeue_size_counter": 1259289609, |
| "dequeue_ts": 1314574422110, |
| "producer_counter": 1, |
| "consumer_counter": 2, |
| "producer_count": 1, |
| "consumer_count": 2, |
| "expired_item_counter": 0, |
| "expired_size_counter": 0, |
| "expired_ts": 0, |
| "nack_item_counter": 0, |
| "nack_size_counter": 0, |
| "nack_ts": 0, |
| "queue_size": 0, |
| "queue_items": 0, |
| "swapped_in_size_max": 0, |
| "swapped_in_size": 0, |
| "swapped_in_items": 0, |
| "swapping_in_size": 0, |
| "swapping_out_size": 0, |
| "swap_out_item_counter": 0, |
| "swap_out_size_counter": 0, |
| "swap_in_item_counter": 0, |
| "swap_in_size_counter": 0 |
| } |
| } |
| </code></pre></div> |
| |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="methods" rowspan="2"> |
| <code> |
| DELETE |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/virtual-hosts/{host}/topics/{dest}.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| </code> |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="description" colspan="2"> |
| <p>Deletes the <code>{dest}</code> topic on the <code>{host}</code> virtual host. Returns a 304 (Not Modified) if the |
| topic is being used by any clients.</p> |
| |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="methods" rowspan="2"> |
| <code> |
| PUT |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/virtual-hosts/{host}/topics/{dest}.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| </code> |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="description" colspan="2"> |
| <p>Creates the <code>{dest}</code> topic on the <code>{host}</code> virtual host.</p> |
| |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/virtual-hosts/{host}/topic-queues/{dest}/{queue}.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| <and></and> |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/QueueStatusDTO.html"> |
| QueueStatusDTO |
| </a> |
| </code> |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="description" colspan="2"> |
| <p>Gets metrics and details about <code>{queue}</code> consumer queue which is being used to |
| spool messages being sent to the <code>{dest}</code> topic on the <code>{host}</code> virtual host.</p> |
| |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/virtual-hosts/{host}/dsubs.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| <and></and> |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/DataPageDTO.html"> |
| DataPageDTO |
| </a> |
| paging |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/QueueStatusDTO.html"> |
| QueueStatusDTO |
| </a> |
| <div></div> |
| </code> |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="description" colspan="2"> |
| <p>Provides tabular access to all durable subscription destinations on the <code>{host}</code> virtual host.</p> |
| |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/virtual-hosts/{host}/dsubs/{dest}.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| <and></and> |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/QueueStatusDTO.html"> |
| QueueStatusDTO |
| </a> |
| </code> |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="description" colspan="2"> |
| <p>Gets metrics and details about the <code>{dest}</code> durable subscription on the <code>{host}</code> virtual host.</p> |
| |
| </td> |
| </tr> |
| </table> |
| |
| <div></div> |
| |
| <h3 id = "Connection_Management">Connection Management</h3> |
| |
| <table class="reference"> |
| <tr> |
| <th></th> |
| <th>Route</th> |
| <th>On Success</th> |
| </tr> |
| <tr class="even"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/connectors.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| <and></and> |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/DataPageDTO.html"> |
| DataPageDTO |
| </a> |
| paging |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/ServiceStatusDTO.html"> |
| ServiceStatusDTO |
| </a> |
| <div></div> |
| </code> |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="description" colspan="2"> |
| <p>Provides tabular access to all connectors on the broker.</p> |
| |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/connectors/{connector}.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| <and></and> |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/ServiceStatusDTO.html"> |
| ServiceStatusDTO |
| </a> |
| </code> |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="description" colspan="2"> |
| <p>Gets details about the <code>{connector}</code>. Example:</p> |
| |
| <p><code>curl -u "admin:password" http://localhost:61680/broker/connectors/tcp.json</code></p> |
| |
| <div class="syntax"><pre name='code' class='brush: js; gutter: false;'><code> |
| { |
| "id": "tcp", |
| "state": "STARTED", |
| "state_since": 1314573798510, |
| "local_address": "/0.0.0.0:61613", |
| "protocol": "any", |
| "connection_counter": 100, |
| "connected": 12 |
| } |
| </code></pre></div> |
| |
| <p>You can the <code>?connections=true</code> query parameter to have a list of connections |
| included n the result.</p> |
| |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="methods" rowspan="2"> |
| <code> |
| POST |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/connectors/{connector}/action/stop.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 303 |
| </code> |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="description" colspan="2"> |
| <p>Stops the <code>{connector}</code>.</p> |
| |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="methods" rowspan="2"> |
| <code> |
| POST |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/connectors/{connector}/action/start.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 303 |
| </code> |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="description" colspan="2"> |
| <p>Starts the <code>{connector}</code>.</p> |
| |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/connection-metrics.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| <and></and> |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/AggregateConnectionMetricsDTO.html"> |
| AggregateConnectionMetricsDTO |
| </a> |
| </code> |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="description" colspan="2"> |
| <p>Aggregates metrics about the connections.</p> |
| |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/connections.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| <and></and> |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/DataPageDTO.html"> |
| DataPageDTO |
| </a> |
| paging |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/ConnectionStatusDTO.html"> |
| ConnectionStatusDTO |
| </a> |
| <div></div> |
| </code> |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="description" colspan="2"> |
| <p>Provides tabular access to all connections on the broker.</p> |
| |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/connections/{connection}.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| <and></and> |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/ConnectionStatusDTO.html"> |
| ConnectionStatusDTO |
| </a> |
| </code> |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="description" colspan="2"> |
| <p>Gets details about the <code>{connection}</code>. Example:</p> |
| |
| <p><code>curl -u "admin:password" http://localhost:61680/broker/connections/108.json</code></p> |
| |
| <div class="syntax"><pre name='code' class='brush: js; gutter: false;'><code> |
| { |
| "id": "108", |
| "state": "STARTED", |
| "state_since": 1314574636579, |
| "last_read_size": 0, |
| "last_write_size": 32973, |
| "read_counter": 106, |
| "write_counter": 632923992, |
| "connector: "tcp", |
| "protocol": "stomp", |
| "protocol_version": "1.0", |
| "remote_address": "/127.0.0.1:51733", |
| "local_address": "/127.0.0.1:61613", |
| "user": "admin", |
| "waiting_on": "client request", |
| "subscription_count": 1 |
| } |
| </code></pre></div> |
| |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="methods" rowspan="2"> |
| <code> |
| DELETE |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/connections/{connection}.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| </code> |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="description" colspan="2"> |
| <p>Deletes the <code>{connection}</code>.</p> |
| |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="methods" rowspan="2"> |
| <code> |
| POST |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/connections/{connection}/action/delete.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 303 |
| </code> |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="description" colspan="2"> |
| <p>Deletes the <code>{connection}</code>.</p> |
| |
| </td> |
| </tr> |
| </table> |
| |
| <div></div> |
| |
| <h3 id = "Broker_Configuration_Management">Broker Configuration Management</h3> |
| |
| <table class="reference"> |
| <tr> |
| <th></th> |
| <th>Route</th> |
| <th>On Success</th> |
| </tr> |
| <tr class="odd"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /config/runtime.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| <and></and> |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/BrokerDTO.html"> |
| BrokerDTO |
| </a> |
| </code> |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="description" colspan="2"> |
| <p>The runtime configuration the broker using. This version |
| of the configuration has all property placeholders resolved |
| and then password fields are cleared.</p> |
| |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /config/runtime.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| <and></and> |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/BrokerDTO.html"> |
| BrokerDTO |
| </a> |
| </code> |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="description" colspan="2"> |
| <p>The runtime configuration the broker using. This version |
| of the configuration has all property placeholders resolved |
| and then password fields are cleared.</p> |
| |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /config/files.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| string array |
| </code> |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="description" colspan="2"> |
| <p>A listing of the configuration files.</p> |
| |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /config/files/{file} |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| bytes |
| </code> |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="description" colspan="2"> |
| <p>Downloads the contents of the config file.</p> |
| |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="methods" rowspan="2"> |
| <code> |
| POST |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /config/files/{file} |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 303 |
| </code> |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="description" colspan="2"> |
| <p>Updates the contents of the config file. You can either post the raw bytes, |
| or post a url encoded form with a field <code>config</code> set to the contents of the file. In |
| the latter case, the content type is expected to be <code>application/x-www-form-urlencoded</code></p> |
| |
| </td> |
| </tr> |
| </table> |
| |
| <div></div> |
| |
| <h3 id = "Session_Management">Session Management</h3> |
| |
| <table class="reference"> |
| <tr> |
| <th></th> |
| <th>Route</th> |
| <th>On Success</th> |
| </tr> |
| <tr class="even"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/whoami.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| <and></and> |
| <a href="http://activemq.apache.org/apollo/versions/1.7.1/website/documentation/api/apollo-dto/org/apache/activemq/apollo/dto/PrincipalDTO.html"> |
| PrincipalDTO |
| </a> |
| array |
| </code> |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="description" colspan="2"> |
| <p>Lists the principals associated with your username. Example: |
| curl -u “admin:password” http://localhost:61680/broker/whoami.json</p> |
| |
| <div class="syntax"><pre name='code' class='brush: js; gutter: false;'><code> |
| [{ |
| "name": "admin", |
| "kind": "org.apache.activemq.jaas.UserPrincipal" |
| }, { |
| "name": "admins", |
| "kind": "org.apache.activemq.jaas.GroupPrincipal" |
| }] |
| </code></pre></div> |
| |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/signin.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| true |
| </code> |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="description" colspan="2"> |
| <p>Log you in using the <code>username</code> and <code>password</code> query parameters. |
| creates a cookie based session.</p> |
| |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="methods" rowspan="2"> |
| <code> |
| POST |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/signin.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| true |
| </code> |
| </td> |
| </tr> |
| <tr class="even"> |
| <td class="description" colspan="2"> |
| <p>Signs you in using the <code>username</code> and <code>password</code> form parameters. |
| Creates a cookie based session.</p> |
| |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="methods" rowspan="2"> |
| <code> |
| GET |
| </code> |
| </td> |
| <td class="path"> |
| <code> |
| /broker/signout.json |
| </code> |
| </td> |
| <td class="codes"> |
| <code> |
| 200 |
| true |
| </code> |
| </td> |
| </tr> |
| <tr class="odd"> |
| <td class="description" colspan="2"> |
| <p>Signs you off by invalidating your session.</p> |
| |
| </td> |
| </tr> |
| </table> |
| |
| <div></div> |
| <div></div> |
| </div> |
| </div> |
| </body> |
| </html> |