Adding rest documentation for nimbus summary.
Project: http://git-wip-us.apache.org/repos/asf/storm/repo Commit: http://git-wip-us.apache.org/repos/asf/storm/commit/726ce80b Tree: http://git-wip-us.apache.org/repos/asf/storm/tree/726ce80b Diff: http://git-wip-us.apache.org/repos/asf/storm/diff/726ce80b Branch: refs/heads/0.11.x-branch Commit: 726ce80be94bbfc5e70813221b36b6f4dfce4ccf Parents: 27ad1fb Author: Parth Brahmbhatt <[email protected]> Authored: Thu Feb 12 15:54:27 2015 -0800 Committer: Parth Brahmbhatt <[email protected]> Committed: Thu Feb 12 15:54:27 2015 -0800 ---------------------------------------------------------------------- STORM-UI-REST-API.md | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/storm/blob/726ce80b/STORM-UI-REST-API.md ---------------------------------------------------------------------- diff --git a/STORM-UI-REST-API.md b/STORM-UI-REST-API.md index ed26cd9..4801a51 100644 --- a/STORM-UI-REST-API.md +++ b/STORM-UI-REST-API.md @@ -72,7 +72,6 @@ Response fields: |Field |Value|Description |--- |--- |--- |stormVersion|String| Storm version| -|nimbusUptime|String| Shows how long the cluster is running| |supervisors|Integer| Number of supervisors running| |slotsTotal| Integer|Total number of available worker slots| |slotsUsed| Integer| Number of worker slots used| @@ -125,6 +124,37 @@ Sample response: } ``` +### /api/v1/nimbus/summary (GET) + +Returns summary information for all nimbus hosts. + +Response fields: + +|Field |Value|Description| +|--- |--- |--- +|host| String | Nimbus' host name| +|port| int| Nimbus' port number| +|nimbusUpTime| String| Shows since how long the nimbus has been running| +|nimbusLogLink| String| Logviewer url to view the nimbus.log| +|version| String| Version of storm this nimbus host is running| + +Sample response: + +```json +{ + "nimbuses":[ + { + "host":"192.168.202.1", + "port":6627, + "nimbusLogLink":"http:\/\/192.168.202.1:8000\/log?file=nimbus.log", + "isLeader":true, + "version":"0.10.0-SNAPSHOT", + "nimbusUpTime":"3m 33s" + } + ] +} +``` + ### /api/v1/topology/summary (GET) Returns summary information for all topologies.
