Skip to content
Snippets Groups Projects
Commit 861166d8 authored by Nikolay Stanchev's avatar Nikolay Stanchev
Browse files

Updates documentation

parent 7163afee
No related branches found
No related tags found
No related merge requests found
......@@ -296,10 +296,11 @@ with **/clmc-service** so that the nginx reverse proxy server (listening on port
}
```
* **GET** ***/graph/temporal/{graph_id}/round-trip-time?compute_node={compute_node_id}&endpoint={endpoint_id}***
* **GET** ***/graph/temporal/{graph_id}/round-trip-time?startpoint={startpoint_id}&endpoint={endpoint_id}***
This API method sends a request to run the Cypher Round-Trip-Time query over a temporal graph associated with a request UUID (retrieved from the response of a build-graph request).
The request UUID must be given in the request URL, e.g. request sent to */graph/temporal/75df6f8d-3829-4fd8-a3e6-b3e917010141/round-trip-time?compute_node=DC2&endpoint=minio_1_ep1*
The request UUID must be given in the request URL, e.g. request sent to */graph/temporal/75df6f8d-3829-4fd8-a3e6-b3e917010141/round-trip-time?startpoint=DC2&endpoint=minio_1_ep1*,
which will return the RTT breakdown for the path starting at Cluster DC2 to SF endpoint minio_1_ep1.
* Response:
......@@ -310,7 +311,7 @@ with **/clmc-service** so that the nginx reverse proxy server (listening on port
Returns a 404 Not Found error if the request UUID and the endpoint ID are not associated with an endpoint node in the graph.
Returns a 404 Not Found error if the compute node ID is not associated with a compute node in the graph.
Returns a 404 Not Found error if the startpoint ID is not associated with a Cluster or Switch node in the graph.
* Response Body Example:
......@@ -341,10 +342,10 @@ with **/clmc-service** so that the nginx reverse proxy server (listening on port
}
```
Here, the *forward_latencies* and *reverse_latencies* lists represent the latency experienced at each hop between compute nodes. For example, if the path was DC2-DC3-DC4 and the SF endpoint was hosted
on DC4, the response data shows that latency(DC2-DC3) = 22, latency(DC3-DC4) = 11, latency(DC4-DC3) = 15, latency(DC3-DC2) = 18, response_time(minio_1_ep1) = 15.75
Here, the *forward_latencies* and *reverse_latencies* lists represent the reported latency at each hop between switches/clusters. For example, if the path was DC2-DC3-DC4 and the SF endpoint was hosted
on DC4, the response data shows that latency(DC2-DC3) = 22, latency(DC3-DC4) = 11, latency(DC4-DC3) = 11, latency(DC3-DC2) = 22, response_time(minio_1_ep1) = 15.75
N.B. if the endpoint is hosted on the compute node identified in the URL parameter, then there will be no network hops between compute nodes, so the latency lists would be empty, example:
N.B. if the endpoint is hosted on the cluster identified in the URL parameter, then there will be no network hops between clusters/switches, so the latency lists would be empty, example:
```json
{
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment