Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Listing Available Application Flows

 

Use the Cloud Analytics Engine CA API list flows resource to retrieve information about application flows CA has discovered are currently active and can be emulated to collect application flow statistics.

GET list/flow Resource

Use the GET list/flow CA API to retrieve a list of all active application flows that CA has “sniffed” (detected) that are running on CA’s host. CA clients can then request to start tracing an application flow of interest using CA probes to collect flow path statistics (see GET start/flow Resource.)

Request Parameters:

  • active: (Boolean, Optional) If “True”, return flows active only for the last 60 seconds. Default is “False”, return all available flows.

Return Codes:

  • EFAIL—Failed to fetch the data.

Response Data:

  • FLOWS: List of flow identifier objects for all flows that were sniffed in the CA host, in JSON format, described in Table 1 .

See List Flows Compute Agent API Example for a sample request and response data.

Table 1: list/flow Resource JSON Response Elements

Element Name

Description

SIP

Source IP address

DIP

Destination IP address

PROTO

Protocol (“tcp” or “udp”)

PORTS

List of flow port information tuples, including the timestamp when CA recorded detection of the application flow.

  • For non-overlay flow, this tuple consists of the following 3 values, in the order shown:

    {timestamp, destination port, source port}.

  • For overlay (tunnel) flow, this tuple consists of the following 11 values, in the order shown:

    {timestamp, destination port, source port, VXLAN identifier, VM source MAC address, VM destination MAC address, VM source IP address, VM destination IP address, VM application protocol, VM application source port, VM application destination port}.

List Flows Compute Agent API Example

These examples show the JSON-format response data returned from CA API requests to list all application flows detected by the target CA server. Note that the response data differs for identifying either non-overlay or overlay (tunnel) flows, depending on what flows are available at the time of the request. These examples show results filtered to only return flows active within the past 60 seconds ( the active parameter is set to “True”). See GET list/flow Resource for details on the supported request parameters and response data elements.

List Flows Example with Non-Overlay Flows

Retrieve a list of flows active within the past 60 seconds (GET list/flow request):

http://10.94.201.11:8080/list/flow?active=True

Response data:

List Flows Example For Overlay (Tunnel) Flows

Retrieve a list of flows active within the past 60 seconds, including overlay (tunnel) flows (GET list/flow request):

http://rod-ix-pc-04:8080/list/flow?active=True

Response data: