Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Requesting Flow Path Trace Data

 

Use the Cloud Analytics Engine DLE API as follows to retrieve analytics data from one or more flow path traces started by DLE API requests.

GET /api/v1/traces

Use this DLE API request to get trace operational data for traces managed by DLE.

Request Format:

  • GET method.

Request Parameters:

  • status: (String) “ACTIVE”, “COMPLETED”, or “SCHEDULED”. Filter trace data results based on trace status, retrieving only traces that are still active (ACTIVE), that have reached the requested trace end time (COMPLETED), or have not yet started (SCHEDULED). If this parameter is omitted, return data for all available traces.

Response Data (JSON format):

  • totalSize: (Numeric) Number of flow traces for which data is being returned.

  • flows: List of detailed trace data for the traces specified in the request, described in the Trace Data Transfer Object.

See Trace Inquiries Data Learning Engine API Example for sample trace data requests and responses.

GET /api/v1/traces/{traceId}

Use this DLE API request to get detailed trace data from DLE for a specified trace ID.

Request Format:

  • GET method

Request Parameters:

  • None.

Response Data:

See Trace Inquiries Data Learning Engine API Example for sample trace data requests and responses.

Trace Data Transfer Object

Table 1 describes the Trace Data transfer object, returned from DLE in response to a request for trace details for one or more traces. See GET /api/v1/traces and GET /api/v1/traces/{traceId}.

Table 1: Trace Data Transfer Object

Element Name

Description

id

(String) Trace ID returned when the trace was requested (see POST /api/v1/traces).

uri

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

sourceIp

(String) Source IP address of the flow path.

destinationIp

(String) Destination IP address of the flow path.

sourcePort

(String) Application source port of the flow.

destinationPort

(String)Application destination port of the flow.

protocol

(String)Protocol for the flow—“TCP” or “UDP”.

vnid

(String) Encapsulation VXLAN network identifier for a tunnel flow.

vmSourceMac

(String) VM application source MAC address for a tunnel flow.

vmDestinationMac

(String) VM application destination MAC address for a tunnel flow.

vmSourceIp

(String) VM application source IP address for a tunnel flow.

vmDestinationIp

(String) VM application destination IP address for a tunnel flow.

vmSourcePort

(String) VM application source port for the flow.

vmDestinationPort

(String) VM application destination port for the flow.

averageE2ELatency

(Numeric) Average end-to-end latency in ms for the flow.

minE2ELatency

(Numeric) Maximum end-to-end latency in ms for the flow.

maxE2ELatency

(Numeric) Minimum end-to-end latency in ms for the flow.

startTime

(Numeric) Time (epoch time in ms) when trace was started or scheduled to be started (if non-active trace data is requested).

endTime

(Numeric) Time (epoch time in ms) when trace ended, or 0 if trace is still active or to be scheduled.

status

(Enumerated String) Run status of flow data trace:

  • “ACTIVE”—Trace still running.

  • “COMPLETED”—Finished at requested trace endTime.

  • “SCHEDULED”—Requested to start at a future startTime.

uriForProbeSummary

(String) URI for the probe summary resource request to retrieve information about the probes that generated this trace.

totalProbeEntries

(Numeric) Number of probe sampling instances (end-to-end flow path traversals) for the trace. This depends on the collection frequency (collectionFreq) specified when requesting to start the trace (see POST /api/v1/traces).

Trace Inquiries Data Learning Engine API Example

The following are DLE API examples for retrieving flow trace details for all available traces (see GET /api/v1/traces) or a specific trace ID (see GET /api/v1/traces/{traceId}). Requests use the GET method. The response data for these requests is in JSON format, and is defined in the Trace Data Transfer Object for each trace.

Trace Data Inquiry Example For All Available Traces

Request:

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

Response:

Trace Data Inquiry Example For a Specified Trace ID

Request:

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

NTEuMC4wLjI6NDUwODQtMjEuMC4wLjI6NDM0NS11ZHBAMTQyNjYyMzk3OTAwMA==

Response: