Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Retrieving Active Tunnel Flows List

 

Use the Cloud Analytics Engine CA API active tunnels resource to retrieve information about tunnel flows you started that are currently active.

GET active/tunnel Resource

Use the GET active/tunnel CA API to retrieve a list of all active tunnel flows for the client who originated the request.

Request Parameters:

  • None

Return Codes:

  • EOK—CA found and returned active tunnel flows for this client.

  • EFAIL—CA failed to find or return active tunnel flows for this client.

Response Data:

  • flows: List of tunnel identifier tuples for all active tunnel flows initiated by this client, in JSON format, with tuple values in order as follows (see descriptions in Table 1:

    • {VTEP src IP, VTEP dst IP, VM dst IP, VM src IP, VXLAN ID, outer source port}

See Active Tunnels Compute Agent API Example for a sample request and response.

Table 1: active/tunnel Resource JSON Response Tuple Elements

Tuple Value

Description

VTEP src IP

VTEP source IP address

VTEP dst IP

VTEP destination IP address

VM dst IP

VM destination IP address

VM src IP

VM source IP address

VXLAN ID

Encapsulation VXLAN ID

outer source port

VTEP-provided UDP source port for the VXLAN encapsulation

Active Tunnels Compute Agent API Example

This example shows the JSON-format response data returned from a CA API request to retrieve all active tunnel flows for the client issuing the request. See GET active/tunnel Resource for details on response data elements.

Request (GET active/tunnel):

http://rod-ix-pc-04:8080/active/tunnel

Response data showing one currently-active tunnel flow: