Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

STORM-1129: Update ui to use topology name #1277

Closed
wants to merge 1 commit into from
Closed

STORM-1129: Update ui to use topology name #1277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 31 additions & 31 deletions docs/STORM-UI-REST-API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ are used by nimbus.
Examples:

```no-highlight
1. http://ui-daemon-host-name:8080/api/v1/topology/wordcount-1-1425844354\?doAsUser=testUSer1
2. curl 'http://localhost:8080/api/v1/topology/wordcount-1-1425844354/activate' -X POST -H 'doAsUser:testUSer1'
1. http://ui-daemon-host-name:8080/api/v1/topology/wordcount\?doAsUser=testUSer1
2. curl 'http://localhost:8080/api/v1/topology/wordcount/activate' -X POST -H 'doAsUser:testUSer1'
```

## GET Operations
Expand Down Expand Up @@ -264,7 +264,7 @@ Sample response:

### /api/v1/topology-workers/:id (GET)

Returns the worker' information (host and port) for a topology.
Returns the worker' information (host and port) for a topology. id can be name or id of the topology

Response fields:

Expand Down Expand Up @@ -297,13 +297,13 @@ Sample response:

### /api/v1/topology/:id (GET)

Returns topology information and statistics. Substitute id with topology id.
Returns topology information and statistics. Substitute id with topology id or name.

Request parameters:

|Parameter |Value |Description |
|----------|--------|-------------|
|id |String (required)| Topology Id |
|id |String (required)| Topology Id or Name |
|window |String. Default value :all-time| Window duration for metrics in seconds|
|sys |String. Values 1 or 0. Default value 0| Controls including sys stats part of the response|

Expand Down Expand Up @@ -361,9 +361,9 @@ Response fields:
Examples:

```no-highlight
1. http://ui-daemon-host-name:8080/api/v1/topology/WordCount3-1-1402960825
2. http://ui-daemon-host-name:8080/api/v1/topology/WordCount3-1-1402960825?sys=1
3. http://ui-daemon-host-name:8080/api/v1/topology/WordCount3-1-1402960825?window=600
1. http://ui-daemon-host-name:8080/api/v1/topology/WordCount3
2. http://ui-daemon-host-name:8080/api/v1/topology/WordCount3?sys=1
3. http://ui-daemon-host-name:8080/api/v1/topology/WordCount3?window=600
```

Sample response:
Expand Down Expand Up @@ -517,7 +517,7 @@ Returns detailed metrics and executor information

|Parameter |Value |Description |
|----------|--------|-------------|
|id |String (required)| Topology Id |
|id |String (required)| Topology Id or Name |
|component |String (required)| Component Id |
|window |String. Default value :all-time| window duration for metrics in seconds|
|sys |String. Values 1 or 0. Default value 0| controls including sys stats part of the response|
Expand Down Expand Up @@ -563,9 +563,9 @@ Response fields:
Examples:

```no-highlight
1. http://ui-daemon-host-name:8080/api/v1/topology/WordCount3-1-1402960825/component/spout
2. http://ui-daemon-host-name:8080/api/v1/topology/WordCount3-1-1402960825/component/spout?sys=1
3. http://ui-daemon-host-name:8080/api/v1/topology/WordCount3-1-1402960825/component/spout?window=600
1. http://ui-daemon-host-name:8080/api/v1/topology/WordCount3/component/spout
2. http://ui-daemon-host-name:8080/api/v1/topology/WordCount3/component/spout?sys=1
3. http://ui-daemon-host-name:8080/api/v1/topology/WordCount3/component/spout?window=600
```

Sample response:
Expand Down Expand Up @@ -731,7 +731,7 @@ Request to start profiler on worker with timeout. Returns status and link to pro

|Parameter |Value |Description |
|----------|--------|-------------|
|id |String (required)| Topology Id |
|id |String (required)| Topology Id or Name |
|host-port |String (required)| Worker Id |
|timeout |String (required)| Time out for profiler to stop in minutes |

Expand All @@ -747,9 +747,9 @@ Response fields:
Examples:

```no-highlight
1. http://ui-daemon-host-name:8080/api/v1/topology/wordcount-1-1446614150/profiling/start/10.11.1.7:6701/10
2. http://ui-daemon-host-name:8080/api/v1/topology/wordcount-1-1446614150/profiling/start/10.11.1.7:6701/5
3. http://ui-daemon-host-name:8080/api/v1/topology/wordcount-1-1446614150/profiling/start/10.11.1.7:6701/20
1. http://ui-daemon-host-name:8080/api/v1/topology/wordcount/profiling/start/10.11.1.7:6701/10
2. http://ui-daemon-host-name:8080/api/v1/topology/wordcount/profiling/start/10.11.1.7:6701/5
3. http://ui-daemon-host-name:8080/api/v1/topology/wordcount/profiling/start/10.11.1.7:6701/20
```

Sample response:
Expand All @@ -769,7 +769,7 @@ Request to dump profiler recording on worker. Returns status and worker id for t

|Parameter |Value |Description |
|----------|--------|-------------|
|id |String (required)| Topology Id |
|id |String (required)| Topology Id or Name |
|host-port |String (required)| Worker Id |

Response fields:
Expand All @@ -782,7 +782,7 @@ Response fields:
Examples:

```no-highlight
1. http://ui-daemon-host-name:8080/api/v1/topology/wordcount-1-1446614150/profiling/dumpprofile/10.11.1.7:6701
1. http://ui-daemon-host-name:8080/api/v1/topology/wordcount/profiling/dumpprofile/10.11.1.7:6701
```

Sample response:
Expand All @@ -800,7 +800,7 @@ Request to stop profiler on worker. Returns status and worker id for the request

|Parameter |Value |Description |
|----------|--------|-------------|
|id |String (required)| Topology Id |
|id |String (required)| Topology Id or Name |
|host-port |String (required)| Worker Id |

Response fields:
Expand All @@ -813,7 +813,7 @@ Response fields:
Examples:

```no-highlight
1. http://ui-daemon-host-name:8080/api/v1/topology/wordcount-1-1446614150/profiling/stop/10.11.1.7:6701
1. http://ui-daemon-host-name:8080/api/v1/topology/wordcount/profiling/stop/10.11.1.7:6701
```

Sample response:
Expand All @@ -831,7 +831,7 @@ Request to dump jstack on worker. Returns status and worker id for the request.

|Parameter |Value |Description |
|----------|--------|-------------|
|id |String (required)| Topology Id |
|id |String (required)| Topology Id or Name |
|host-port |String (required)| Worker Id |

Response fields:
Expand All @@ -844,7 +844,7 @@ Response fields:
Examples:

```no-highlight
1. http://ui-daemon-host-name:8080/api/v1/topology/wordcount-1-1446614150/profiling/dumpjstack/10.11.1.7:6701
1. http://ui-daemon-host-name:8080/api/v1/topology/wordcount/profiling/dumpjstack/10.11.1.7:6701
```

Sample response:
Expand All @@ -862,7 +862,7 @@ Request to dump heap (jmap) on worker. Returns status and worker id for the requ

|Parameter |Value |Description |
|----------|--------|-------------|
|id |String (required)| Topology Id |
|id |String (required)| Topology Id or Name |
|host-port |String (required)| Worker Id |

Response fields:
Expand All @@ -875,7 +875,7 @@ Response fields:
Examples:

```no-highlight
1. http://ui-daemon-host-name:8080/api/v1/topology/wordcount-1-1446614150/profiling/dumpheap/10.11.1.7:6701
1. http://ui-daemon-host-name:8080/api/v1/topology/wordcount/profiling/dumpheap/10.11.1.7:6701
```

Sample response:
Expand All @@ -893,7 +893,7 @@ Request to request the worker. Returns status and worker id for the request.

|Parameter |Value |Description |
|----------|--------|-------------|
|id |String (required)| Topology Id |
|id |String (required)| Topology Id or Name |
|host-port |String (required)| Worker Id |

Response fields:
Expand All @@ -906,7 +906,7 @@ Response fields:
Examples:

```no-highlight
1. http://ui-daemon-host-name:8080/api/v1/topology/wordcount-1-1446614150/profiling/restartworker/10.11.1.7:6701
1. http://ui-daemon-host-name:8080/api/v1/topology/wordcount/profiling/restartworker/10.11.1.7:6701
```

Sample response:
Expand All @@ -926,7 +926,7 @@ Activates a topology.

|Parameter |Value |Description |
|----------|--------|-------------|
|id |String (required)| Topology Id |
|id |String (required)| Topology Id or Name |

Sample Response:

Expand All @@ -941,7 +941,7 @@ Deactivates a topology.

|Parameter |Value |Description |
|----------|--------|-------------|
|id |String (required)| Topology Id |
|id |String (required)| Topology Id or Name |

Sample Response:

Expand All @@ -956,7 +956,7 @@ Rebalances a topology.

|Parameter |Value |Description |
|----------|--------|-------------|
|id |String (required)| Topology Id |
|id |String (required)| Topology Id or Name |
|wait-time |String (required)| Wait time before rebalance happens |
|rebalanceOptions| Json (optional) | topology rebalance options |

Expand All @@ -973,7 +973,7 @@ Examples:
curl -i -b ~/cookiejar.txt -c ~/cookiejar.txt -X POST
-H "Content-Type: application/json"
-d '{"rebalanceOptions": {"numWorkers": 2, "executors": { "spout" : "5", "split": 7, "count": 5 }}, "callback":"foo"}'
http://localhost:8080/api/v1/topology/wordcount-1-1420308665/rebalance/0
http://localhost:8080/api/v1/topology/wordcount/rebalance/0
```

Sample Response:
Expand All @@ -990,7 +990,7 @@ Kills a topology.

|Parameter |Value |Description |
|----------|--------|-------------|
|id |String (required)| Topology Id |
|id |String (required)| Topology Id or Name |
|wait-time |String (required)| Wait time before rebalance happens |

Caution: Small wait times (0-5 seconds) may increase the probability of triggering the bug reported in
Expand Down
Loading