[
https://issues.apache.org/jira/browse/STORM-367?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14043611#comment-14043611
]
ASF GitHub Bot commented on STORM-367:
--------------------------------------
Github user harshach commented on a diff in the pull request:
https://github.com/apache/incubator-storm/pull/157#discussion_r14192389
--- Diff: STORM-UI-REST-API.md ---
@@ -0,0 +1,513 @@
+# Storm UI REST API
+Storm UI server provides a REST Api to access cluster, topology, component
overview and metrics.
+This api returns json response.
+
+## Using the UI REST Api
+
+### /api/v1/cluster/configuration (GET)
+ returns cluster configuration.
+
+Sample Response:
+```json
+ {
+ "dev.zookeeper.path": "/tmp/dev-storm-zookeeper",
+ "topology.tick.tuple.freq.secs": null,
+ "topology.builtin.metrics.bucket.size.secs": 60,
+ "topology.fall.back.on.java.serialization": true,
+ "topology.max.error.report.per.interval": 5,
+ "zmq.linger.millis": 5000,
+ "topology.skip.missing.kryo.registrations": false,
+ "storm.messaging.netty.client_worker_threads": 1,
+ "ui.childopts": "-Xmx768m",
+ "storm.zookeeper.session.timeout": 20000,
+ "nimbus.reassign": true,
+ "topology.trident.batch.emit.interval.millis": 500,
+ "storm.messaging.netty.flush.check.interval.ms": 10,
+ "nimbus.monitor.freq.secs": 10,
+ "logviewer.childopts": "-Xmx128m",
+ "java.library.path": "/usr/local/lib:/opt/local/lib:/usr/lib",
+ "topology.executor.send.buffer.size": 1024,
+ }
+```
+
+### /api/v1/cluster/summary (GET)
+returns cluster summary such as nimbus uptime,number of supervisors,slots
etc..
+
+Response Fields:
+
+|Field |Description|
+|--- |--- |
+|stormVersion| Storm version|
+|nimbusUptime| Shows how long the cluster is running|
+|supervisors| Number of supervisors running|
+|slotsTotal| Total number of available worker slots|
+|slotsUsed| Number of worker slots used|
+|slotsFree| Number of worker slots available|
+|executorsTotal| Total number of executors|
+|tasksTotal| Total tasks|
+
+Sample Response:
+```json
+ {
+ "stormVersion": "0.9.2-incubating-SNAPSHOT",
+ "nimbusUptime": "3m 53s",
--- End diff --
By format you mean type of the fields?
> Storm UI REST api documentation
> -------------------------------
>
> Key: STORM-367
> URL: https://issues.apache.org/jira/browse/STORM-367
> Project: Apache Storm (Incubating)
> Issue Type: Documentation
> Reporter: Sriharsha Chintalapani
>
--
This message was sent by Atlassian JIRA
(v6.2#6252)
