Add REST API docs for topology/history and topology-workers/:id
Project: http://git-wip-us.apache.org/repos/asf/storm/repo Commit: http://git-wip-us.apache.org/repos/asf/storm/commit/18abd035 Tree: http://git-wip-us.apache.org/repos/asf/storm/tree/18abd035 Diff: http://git-wip-us.apache.org/repos/asf/storm/diff/18abd035 Branch: refs/heads/master Commit: 18abd0358fd7b8b7ae482f8502ffe16a8c31e67c Parents: 9e907dc Author: zhuol <[email protected]> Authored: Tue Nov 3 15:50:41 2015 -0600 Committer: zhuol <[email protected]> Committed: Mon Nov 9 11:51:09 2015 -0600 ---------------------------------------------------------------------- docs/documentation/ui-rest-api.md | 54 ++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/storm/blob/18abd035/docs/documentation/ui-rest-api.md ---------------------------------------------------------------------- diff --git a/docs/documentation/ui-rest-api.md b/docs/documentation/ui-rest-api.md index b9b747c..1716cc9 100644 --- a/docs/documentation/ui-rest-api.md +++ b/docs/documentation/ui-rest-api.md @@ -172,6 +172,27 @@ Sample response: } ``` +### /api/v1/history/summary (GET) + +Returns a list of topology ID submitted by the current user. + +Response fields: + +|Field |Value | Description| +|--- |--- |--- +|topo-history| List| List of Topologies' IDs| + +Sample response: + +```json +{ + "topo-history":[ + {"host":"wc6-1-1446571009"}, + {"host":"wc8-2-1446587178"} + ] +} +``` + ### /api/v1/topology/summary (GET) Returns summary information for all topologies. @@ -226,6 +247,39 @@ Sample response: } ``` +### /api/v1/topology-workers/:id (GET) + +Returns the worker' information (host and port) for a topology. + +Response fields: + +|Field |Value | Description| +|--- |--- |--- +|hostPortList| List| Workers' information for a topology| +|name| Integer| Logviewer Port| + +Sample response: + +```json +{ + "hostPortList":[ + { + "host":"192.168.202.2", + "port":6701 + }, + { + "host":"192.168.202.2", + "port":6702 + }, + { + "host":"192.168.202.3", + "port":6700 + } + ], + "logviewerPort":8000 +} +``` + ### /api/v1/topology/:id (GET) Returns topology information and statistics. Substitute id with topology id.
