Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Requesting Summary Probe Data for a Trace

 

Use the Cloud Analytics Engine DLE API as follows to retrieve a summary of probe data for a DLE flow path trace, including additional per-hop summary data, if desired.

GET /api/v1/traces/{traceId}/probes [?additionalInfo=hops]

Use this DLE API request to get probe summary data from DLE for the specified trace ID.

Request Format:

  • GET method

Request Parameters:

  • None: Instructs DLE to return only probe summary data.

  • additionalInfo: Instructs DLE to return probe summary data and the specified additional data. Values supported: “hops”—Specifying additionalInfo=hops returns hop summary data for each probe in addition to probe summary data.

Response Data (JSON format):

  • id: (String) Trace ID of the trace for which probe summary information was requested

  • totalSize: (Numeric) Total number of probes for which results are being returned

  • probes: List of probe summary information for each probe, described in Probe Summary Transfer Object. The list includes hop summary information (described in HopSummary Transfer Object) if the request included parameter “additionalInfo=hops”.

See Probe Inquiry Data Learning Engine API Example for a sample probe summary data request and response.

Probe Summary Transfer Object

Table 1 describes the Probe Summary transfer object, returned in JSON format in response to a request for probe summary data for a particular trace managed by DLE (see GET /api/v1/traces/{traceId}/probes [?additionalInfo=hops]).

Table 1: Probe Summary Transfer Object

Element Name

Description

differentPath

(Boolean) If “true”, indicates this probe followed a different path (due to routing differences) than previous probes in the flow path for this trace. If “false”, this probe’s path matches that of the previous probe.

timestamp

(Numeric) Timestamp (epoch time in ms) when this probe started on its path.

maxHopLatency

(Numeric) Maximum hop latency in ms among all the hops recorded in this probe’s flow path.

uri

(String) URI for the probe summary data resource request related to this data.

hopCount

(Numeric) Number of hops in this probe’s flow path, and the size of the list of HopSummary objects in the hops element (described next).

hops

List of HopSummary transfer objects, which contain summary data for each hop in the probe’s path, defined in the HopSummary Transfer Object. This data is included in the response if the request includes the additionalInfo=hops option.

HopSummary Transfer Object

Table 2 describes the HopSummary transfer object, which is included in DLE API probe summary response data (see GET /api/v1/traces/{traceId}/probes [?additionalInfo=hops] and Probe Summary Transfer Object) when the request specifies the additionalInfo=hops parameter.

Table 2: HopSummary Transfer Object

Element Name

Description

deviceSerial

(String) Device serial number for this hop.

latency

(Numeric) Latency in ms for this hop in the flow path.

Probe Inquiry Data Learning Engine API Example

The following are DLE API examples for retrieving probe summary data for a particular trace ID with and without additional hops summary information. See GET /api/v1/traces/{traceId}/probes [?additionalInfo=hops]. Requests use the GET method. The response data is in JSON format, and is described in Probe Summary Transfer Object and HopSummary Transfer Object.

Probe Summary Inquiry Example

Request:

http://192.168.55.102:8282/api/v1/traces/

NTYuNS4zLjE1OjMxMTgtNjYuNS4zLjE1OjQxMTgtdWRwQDE0MjMwODgzMzQ1NTE=/probes

Response:

Probe Summary Inquiry Example With Additional Hop Summary Information

Request:

http://192.168.55.102:8282/api/v1/traces/

NTYuNS4zLjE1OjMxMTgtNjYuNS4zLjE1OjQxMTgtdWRwQDE0MjMwODgzMzQ1NTE=/

probes?additionalInfo=hops

Response: