Cloud Analytics Engine Compute Agent API Reference

Transcription

1 Cloud Analytics Engine Compute Agent API Reference Release 14.1X53 Published:

2 Juniper Networks, Inc North Mathilda Avenue Sunnyvale, California USA Juniper Networks, Junos, Steel-Belted Radius, NetScreen, and ScreenOS are registered trademarks of Juniper Networks, Inc. in the United States and other countries. The Juniper Networks Logo, the Junos logo, and JunosE are trademarks of Juniper Networks, Inc. All other trademarks, service marks, registered trademarks, or registered service marks are the property of their respective owners. Juniper Networks assumes no responsibility for any inaccuracies in this document. Juniper Networks reserves the right to change, modify, transfer, or otherwise revise this publication without notice. Cloud Analytics Engine Compute Agent API Reference 14.1X53 All rights reserved. The information in this document is current as of the date on the title page. YEAR 2000 NOTICE Juniper Networks hardware and software products are Year 2000 compliant. Junos OS has no known time-related limitations through the year However, the NTP application is known to have some difficulty in the year END USER LICENSE AGREEMENT The Juniper Networks product that is the subject of this technical documentation consists of (or is intended for use with) Juniper Networks software. Use of such software is subject to the terms and conditions of the End User License Agreement ( EULA ) posted at By downloading, installing or using such software, you agree to the terms and conditions of that EULA. ii

3 Table of Contents About the Documentation vii Documentation and Release Notes vii Supported Platforms vii Using the Examples in This Manual vii Merging a Full Example viii Merging a Snippet viii Documentation Conventions ix Documentation Feedback xi Requesting Technical Support xi Self-Help Online Tools and Resources xi Opening a Case with JTAC xii Part 1 Reference Chapter 1 Compute Agent API Overview Compute Agent API Resources Overview Chapter 2 Compute Agent API Reference GET start/flow Resource GET stop/flow Resource GET data/flow Resource GET start/tunnel Resource GET stop/tunnel Resource GET data/tunnel Resource GET list/flow Resource GET active/flow Resource GET active/tunnel Resource iii

4 Cloud Analytics Engine Compute Agent API Reference iv

5 List of Tables About the Documentation vii Table 1: Notice Icons ix Table 2: Text and Syntax Conventions ix Part 1 Reference Chapter 1 Compute Agent API Overview Table 3: Compute Agent API Resources Overview Chapter 2 Compute Agent API Reference Table 4: GET start/flow Resource Parameters Table 5: GET stop/flow Resource Parameters Table 6: GET data/flow Resource Parameters Table 7: data/flow Resource JSON Response Elements Table 8: GET start/tunnel Resource Parameters Table 9: GET stop/tunnel Resource Parameters Table 10: GET data/tunnel Resource Parameters Table 11: data/tunnel Resource JSON Response Elements Table 12: GET list/flow Resource Parameters Table 13: list/flow Resource JSON Response Elements Table 14: GET active/flow Resource Parameters Table 15: GET active/tunnel Resource Parameters v

6 Cloud Analytics Engine Compute Agent API Reference vi

7 About the Documentation Documentation and Release Notes Documentation and Release Notes on page vii Supported Platforms on page vii Using the Examples in This Manual on page vii Documentation Conventions on page ix Documentation Feedback on page xi Requesting Technical Support on page xi Supported Platforms To obtain the most current version of all Juniper Networks technical documentation, see the product documentation page on the Juniper Networks website at If the information in the latest release notes differs from the information in the documentation, follow the product Release Notes. Juniper Networks Books publishes books by Juniper Networks engineers and subject matter experts. These books go beyond the technical documentation to explore the nuances of network architecture, deployment, and administration. The current list can be viewed at For the features described in this document, the following platforms are supported: QFX Series standalone switches Using the Examples in This Manual If you want to use the examples in this manual, you can use the load merge or the load merge relative command. These commands cause the software to merge the incoming configuration into the current candidate configuration. The example does not become active until you commit the candidate configuration. If the example configuration contains the top level of the hierarchy (or multiple hierarchies), the example is a full example. In this case, use the load merge command. vii

8 Cloud Analytics Engine Compute Agent API Reference Merging a Full Example If the example configuration does not start at the top level of the hierarchy, the example is a snippet. In this case, use the load merge relative command. These procedures are described in the following sections. To merge a full example, follow these steps: 1. From the HTML or PDF version of the manual, copy a configuration example into a text file, save the file with a name, and copy the file to a directory on your routing platform. For example, copy the following configuration to a file and name the file ex-script.conf. Copy the ex-script.conf file to the /var/tmp directory on your routing platform. system { scripts { commit { file ex-script.xsl; } } } interfaces { fxp0 { disable; unit 0 { family inet { address /24; } } } } 2. Merge the contents of the file into your routing platform configuration by issuing the load merge configuration mode command: [edit] user@host# load merge /var/tmp/ex-script.conf load complete Merging a Snippet To merge a snippet, follow these steps: 1. From the HTML or PDF version of the manual, copy a configuration snippet into a text file, save the file with a name, and copy the file to a directory on your routing platform. For example, copy the following snippet to a file and name the file ex-script-snippet.conf. Copy the ex-script-snippet.conf file to the /var/tmp directory on your routing platform. commit { file ex-script-snippet.xsl; } 2. Move to the hierarchy level that is relevant for this snippet by issuing the following configuration mode command: viii

9 About the Documentation [edit] edit system scripts [edit system scripts] 3. Merge the contents of the file into your routing platform configuration by issuing the load merge relative configuration mode command: [edit system scripts] load merge relative /var/tmp/ex-script-snippet.conf load complete Documentation Conventions For more information about the load command, see the CLI User Guide. Table 1: Notice Icons Table 1 on page ix defines notice icons used in this guide. Icon Meaning Informational note Indicates important features or instructions. Caution Indicates a situation that might result in loss of data or hardware damage. Warning Alerts you to the risk of personal injury or death. Laser warning Alerts you to the risk of personal injury from a laser. Tip Indicates helpful information. Best practice Alerts you to a recommended use or implementation. Table 2: Text and Syntax Conventions Table 2 on page ix defines the text and syntax conventions used in this guide. Convention Examples Bold text like this Represents text that you type. To enter configuration mode, type the configure command: user@host> configure ix

10 Cloud Analytics Engine Compute Agent API Reference Table 2: Text and Syntax Conventions (continued) Convention Examples Fixed-width text like this Italic text like this Represents output that appears on the terminal screen. Introduces or emphasizes important new terms. Identifies guide names. Identifies RFC and Internet draft titles. show chassis alarms No alarms currently active A policy term is a named structure that defines match conditions and actions. Junos OS CLI User Guide RFC 1997, BGP Communities Attribute Italic text like this Text like this Represents variables (options for which you substitute a value) in commands or configuration statements. Represents names of configuration statements, commands, files, and directories; configuration hierarchy levels; or labels on routing platform components. Configure the machine s domain name: [edit] root@# set system domain-name domain-name To configure a stub area, include the stub statement at the [edit protocols ospf area area-id] hierarchy level. The console port is labeled CONSOLE. < > (angle brackets) Encloses optional keywords or variables. stub <default-metric metric>; (pipe symbol) Indicates a choice between the mutually exclusive keywords or variables on either side of the symbol. The set of choices is often enclosed in parentheses for clarity. broadcast multicast (string1 string2 string3) # (pound sign) Indicates a comment specified on the same line as the configuration statement to which it applies. rsvp { # Required for dynamic MPLS only [ ] (square brackets) Encloses a variable for which you can substitute one or more values. community name members [ community-ids ] Indention and braces ( { } ) ; (semicolon) Identifies a level in the configuration hierarchy. Identifies a leaf statement at a configuration hierarchy level. [edit] routing-options { static { route default { nexthop address; retain; } } } GUI Conventions Bold text like this Represents graphical user interface (GUI) items you click or select. In the Logical Interfaces box, select All Interfaces. To cancel the configuration, click Cancel. x

11 About the Documentation Table 2: Text and Syntax Conventions (continued) Convention Examples > (bold right angle bracket) Separates levels in a hierarchy of menu selections. In the configuration editor hierarchy, select Protocols>Ospf. Documentation Feedback We encourage you to provide feedback, comments, and suggestions so that we can improve the documentation. You can provide feedback by using either of the following methods: Online feedback rating system On any page at the Juniper Networks Technical Documentation site at simply click the stars to rate the content, and use the pop-up form to provide us with information about your experience. Alternately, you can use the online feedback form at Send your comments to techpubs-comments@juniper.net. Include the document or topic name, URL or page number, and software version (if applicable). Requesting Technical Support Technical product support is available through the Juniper Networks Technical Assistance Center (JTAC). If you are a customer with an active J-Care or JNASC support contract, or are covered under warranty, and need post-sales technical support, you can access our tools and resources online or open a case with JTAC. JTAC policies For a complete understanding of our JTAC procedures and policies, review the JTAC User Guide located at Product warranties For product warranty information, visit JTAC hours of operation The JTAC centers have resources available 24 hours a day, 7 days a week, 365 days a year. Self-Help Online Tools and Resources For quick and easy problem resolution, Juniper Networks has designed an online self-service portal called the Customer Support Center (CSC) that provides you with the following features: Find CSC offerings: Search for known bugs: Find product documentation: Find solutions and answer questions using our Knowledge Base: xi

12 Cloud Analytics Engine Compute Agent API Reference Download the latest versions of software and review release notes: Search technical bulletins for relevant hardware and software notifications: Join and participate in the Juniper Networks Community Forum: Open a case online in the CSC Case Management tool: To verify service entitlement by product serial number, use our Serial Number Entitlement (SNE) Tool: Opening a Case with JTAC You can open a case with JTAC on the Web or by telephone. Use the Case Management tool in the CSC at Call JTAC ( toll-free in the USA, Canada, and Mexico). For international or direct-dial options in countries without toll-free numbers, see xii

13 PART 1 Reference Compute Agent API Overview on page 3 Compute Agent API Reference on page 5 1

14 Cloud Analytics Engine Compute Agent API Reference 2

15 CHAPTER 1 Compute Agent API Overview Compute Agent API Resources Overview on page 3 Compute Agent API Resources Overview GET method is used for both requesting the data and sending an instruction. A flow is defined by a 5-tupple : SIP, DIP, PROTO, SPORT and DPORT A tunnel is defined as an encapsulation type. This version of the API supports the VxLAN encapsulation type. Except list/flow, all APIs also accept an HTTP header originator, which is expected to be the authorized owner of the flow (normal or tunnel). Error codes: 'EOK -> 0 'EAGAIN -> 1 'EFAIL -> 2 'E_NO_OWNER' -> 3 'E_AoF' -> 4 Table 3 on page 3 describes the resources available in the Compute Agent API. Table 3: Compute Agent API Resources Overview Resource GET start/flow Starts collecting information about a flow from the network. This is an asynchronous API. GET start/tunnel Starts sending information about the tunnel to the network and may also collect information about the network for this tunnel. This is an asynchronous API. GET stop/flow Stops an active flow collector. If the flow is not present returns NULL. This is an asynchronous API. Get stop/tunnel Stops an active tunnel collector. If the tunnel is not present returns NULL. This is an asynchronous API. 3

16 Cloud Analytics Engine Compute Agent API Reference Table 3: Compute Agent API Resources Overview (continued) Resource GET data/flow Returns an active flow related network data. If the flow is not present returns NULL. This is a synchronous API. No wildcards are supported. GET active/flow Returns EOK if probe is active for this flow else returns EFAIL. GET data/tunnel Returns an active tunnel related network data. If the tunnel is not present returns NULL. This is a synchronous API. GET active/tunnel Return EOK if probe is active for this tunnel else returns EFAIL. GET list/flow Returns all flows active in kernel. Related Documentation Cloud Analytics Engine Compute Agent API Reference 4

17 CHAPTER 2 Compute Agent API Reference GET start/flow Resource GET start/flow Resource on page 5 GET stop/flow Resource on page 7 GET data/flow Resource on page 8 GET start/tunnel Resource on page 11 GET stop/tunnel Resource on page 13 GET data/tunnel Resource on page 14 GET list/flow Resource on page 16 GET active/flow Resource on page 17 GET active/tunnel Resource on page 18 The GET start/flow resource starts collecting information about a flow from the network. This is an asynchronous API. Table 4 on page 5 describes the GET start/flow API resource parameters. Table 4: GET start/flow Resource Parameters Flow Resource Parameters GET start/flow/... Flow is defined as 5 tupple and is active between two IPv4 endpoints. Return values: EOK All is good. EAGAIN Exceeding pending updates for the same flow. This will happen when the same flow is modified. EFAIL Invalid parameters. E_UNAUTHORIZED Flow is initiated by a different entity and therefore cannot be modified or started by the originator of this request. dst Destination IPv4 address of interest. scr Source IPv4 address of interest. 5

18 Cloud Analytics Engine Compute Agent API Reference Table 4: GET start/flow Resource Parameters (continued) Flow Resource Parameters proto Protocol Type. UDP and TCP are supported. Default: udp. sport Source Port for a given protocol type. Default: dport Destination Port for a given protocol type. Default: sfreq Sampling Frequency for collecting network data (in seconds). Request is sent every sfreq. Default: 1 second. nhops Number of network hops to gather information from. Information will be gathered across all the hops till dst if nhops field is not specified. Default: 255. ntry Number of retries to attempt in case of timeout on a given hop. If ntry is not specified only single attempt is made to gather information. Default: 1. timeout Timeout (in msec) specifies the value to wait for a given hop to respond. If device doesn t responds back within timeout value, it will ignore the delayed response. Default: 30 seconds. chksum Checksum computation enabled or disabled. Default: Enabled. 6

19 Chapter 2: Compute Agent API Reference Table 4: GET start/flow Resource Parameters (continued) Flow Resource Parameters bw_ingress Measure flow bandwidth at each hop ingress. Default: False. mirror_type Install mirror for this flow. Default: None. mirror_dir Direction of Mirror. Default: None. mirror_analyzer Analyzer IP address. Default: None. port-mirror-local Enable port mirror at each hop Default: False. port-mirror-remote Enable remote port mirroring (RSPAN). Default: False. Related Documentation Compute Agent API Resources Overview on page 3 GET stop/flow Resource The GET stop/flow resource stops collecting information about a flow from the network. This is an asynchronous API. Table 5 on page 8 describes the GET stop/flow API resource parameters. 7

20 Cloud Analytics Engine Compute Agent API Reference Table 5: GET stop/flow Resource Parameters Flow Resource Parameters GET stop/flow/... Flow is defined as 5 tupple and is active between two IPv4 endpoints. Return values: EOK Initiated stop signal to flow thread. EFAIL Invalid parameters. E_AoF No such flow.. E_UNAUTHORIZED Flow is initiated by a different entity and therefore cannot be stopped by the originator of this request. dst Destination IPv4 address of interest. scr Source IPv4 address of interest. proto Protocol Type. UDP and TCP are supported. Default: udp. sport Source Port for a given protocol type. Default: dport Destination Port for a given protocol type. Default: Related Documentation Compute Agent API Resources Overview on page 3 GET data/flow Resource The GET data/flow resource requests analytics data for a flow. This is a synchronous API. Table 6 on page 9 describes the GET data/flow API resource parameters. Table 7 on page 9 describes the data/flow resource JSON response elements. 8

21 Chapter 2: Compute Agent API Reference Table 6: GET data/flow Resource Parameters Flow Resource Parameters GET data/flow/... Flow is defined as 5 tupple and is active between two IPv4 endpoints. Return values: JSON string formed from device data. EFAIL no data is present.. E_AoF No such flow.. E_UNAUTHORIZED Flow is initiated by a different entity and therefore cannot be stopped by the originator of this request. dst Destination IPv4 address of interest. scr Source IPv4 address of interest. proto Protocol Type. UDP and TCP are supported. Default: udp. sport Source Port for a given protocol type. Default: dport Destination Port for a given protocol type. Default: Table 7: data/flow Resource JSON Response Elements Element Time Time at which probe run was started. ID tuple Identifier for the flow. Path Object representing the path for the flow. HOP Number identifying the position of node in the path. DevMEMUtil Memory Utilization of the node expressed as percentage. DevCPUUtil CPU utlization of node expressed as percentage. Bandwidth_Counter Counter to track the flow packet count at the node. 9

22 Cloud Analytics Engine Compute Agent API Reference Table 7: data/flow Resource JSON Response Elements (continued) Element Bandwidth_ID Bandwidth measurement ID to track reset of bandwidth filters. Latency Latency for the node from CA server. DevName Node name. DevSerialID Node serial id. TIMESTAMP Object representing the time at which flow packet was received at the node. TimeStamp The seconds portion of the TIMESTAMP object. TimeStamp_usec Microseconds portion of the TIMESTAMP object. Type Type of the TIMESTAMP i.e., PTP, LCPU or NTP. IngressIFLAttribute Object representing Ingress interface attribute. L2EcmpList List of layer2 ECMP objects. NumBuckets Number of buckets in the ECMP. AE_IFL_NAME Aggregated interface name. IFLList List of interface objects. IFLName Interface name. IFLStats Object representing interface statistics. TX_PKTS Total transmit packets on the interface. RX_PKTS Total receive packets on the interface. TX_UCPKTS Total number of egress/transmitted unicast packets on the interface. RX_UCPKTS Total number of ingress/received unicast packets on the interface. TX_BCPKTS Total number of outgoing broadcast packets. RX_BCPKTS Total number of incoming broadcast packets. TX_MCPKTS Total outgoing multicast packets. RX_MCPKTS Total incoming multicast packets. TX_PPS Transmit bandwidth interms of packets per second. 10

23 Chapter 2: Compute Agent API Reference Table 7: data/flow Resource JSON Response Elements (continued) Element RX_PPS Receive bandwidth interms of packets per second. TX_CRCERROR Total CRC align errors on TX. RX_CRCERROR Total CRC align errors on RX. TX_DROPPKT Cumulative tx packet drop in all the queues for the interface. RX_DROPPKT Rx packet drops while ingressing the interface, reason could be buffer full etc. TX_BYTES Total transmit bytes. RX_BYTES Total receive bytes. TX_BW Transmit bandwidth (bytes per second), i.e average rate at which packet bytes are transmitted. RX_BW Receive bandwidth (bytes per second), i.e average rate at which packet bytes are received. EgressIFLAttribute Object representing Egress interface attribute. L3Ecmp Object representing layer 3 ECMP. Related Documentation Compute Agent API Resources Overview on page 3 GET start/tunnel Resource The GET start/tunnel resource starts collecting information about a tunnel from the network. This is an asynchronous API. Table 8 on page 11 describes the GET start/tunnel API resource parameters. Table 8: GET start/tunnel Resource Parameters Flow Resource Parameters GET start/tunnel/... Overlay Tunnel information. Return values: EOK All is good. EAGAIN Exceeding pending updates for the same flow. This will happen when the same flow is modified. EFAIL Invalid parameters. E_UNAUTHORIZED Flow is initiated by a different entity and therefore cannot be modified or started by the originator of this request. 11

24 Cloud Analytics Engine Compute Agent API Reference Table 8: GET start/tunnel Resource Parameters (continued) Flow Resource Parameters scr VTEP Source IPv4 address. dst VTEP endpoint Ipv4 address. sport Source Port for a given protocol type. vnid VxLAN Network Identifier. appsrc Application Source IP address talking on this VTEP tunnel. appdst Application Destination IP address for the appsrc. appsmac Application Source MAC address. appdmac Application Destination MAC address. sfreq Sampling Frequency for collecting network data (in seconds). Request is sent every sfreq. Default: 1 second. nhops Number of network hops to gather information from. Information will be gathered across all the hops till dst if nhops field is not specified. Optional parameter Default: 255 ntry Number of retries to attempt in case of timeout on a given hop. If ntry is not specified only single attempt is made to gather information. Optional parameter Default: 1 timeout Timeout (in msec) specifies the value to wait for a given hop to respond. If device doesn t responds back within timeout value, it will ignore the delyed response. Optional parameter Default: 30 seconds chksum Checksum computation enabled or disable. Optional parameter Default: Enabled 12

25 Chapter 2: Compute Agent API Reference Table 8: GET start/tunnel Resource Parameters (continued) Flow Resource Parameters bw-ingress Measure flow bandwidth at each hop ingress. Optional parameter Default: False mirror_type Install mirror for this flow. Default: None. mirror_dir Direction of Mirror. Default: None. mirror_analyzer Analyzer IP address. Default: None. Related Documentation Compute Agent API Resources Overview on page 3 GET stop/tunnel Resource The GET stop/tunnel resource stops collecting information about a tunnel from the network. This is an asynchronous API. Table 9 on page 13 describes the GET stop/tunnel API resource parameters. Table 9: GET stop/tunnel Resource Parameters Flow Resource Parameters GET stop/tunnel/... Overlay Tunnel information. Return values: EOK All is good. EFAIL Invalid parameters. E_AoF No such flow. E_UNAUTHORIZED Flow is initiated by a different entity and therefor cannot be stopped by the originator of this request. scr VTEP Source IPv4 address. dst VTEP endpoint Ipv4 address. 13

26 Cloud Analytics Engine Compute Agent API Reference Table 9: GET stop/tunnel Resource Parameters (continued) Flow Resource Parameters vnid VxLAN Network Identifier. sport Source Port for a given protocol type. appsrc Application Source IP address talking on this VTEP tunnel. appdst Application Destination IP address for the appsrc. Related Documentation Compute Agent API Resources Overview on page 3 GET data/tunnel Resource The GET data/tunnel resource requests analytics data about a tunnel from the network. This is an asynchronous API. Table 10 on page 14 describes the GET data/tunnel API resource parameters. Table 11 on page 15 describes the data/tunnel resource JSON response elements. Table 10: GET data/tunnel Resource Parameters Flow Resource Parameters GET data/tunnel/... Overlay Tunnel information. Return values: JSON string formed from device data. Or one of the following: EFAIL no data is present.. E_AoF No such flow. E_UNAUTHORIZED Flow is initiated by a different entity and therefor cannot be stopped by the originator of this request. scr VTEP Source IPv4 address dst VTEP endpoint Ipv4 address vnid VxLAN Network Identifier appsrc Application Source IP address talking on this VTEP tunnel appdst Application Destination IP address for the appsrc 14

27 Chapter 2: Compute Agent API Reference Table 11: data/tunnel Resource JSON Response Elements Element Time Time at which probe run was started. ID tuple Identifier for the flow. Path Object representing the path for the flow. HOP Number identifying the position of node in the path. DevMEMUtil Memory Utilization of the node expressed as percentage. DevCPUUtil CPU utlization of node expressed as percentage. Bandwidth_Counter Counter to track the flow packet count at the node. Bandwidth_ID Bandwidth measurement ID to track reset of bandwidth filters. Latency Latency for the node from CA server. DevName Node name. DevSerialID Node serial id. TIMESTAMP Object representing the time at which flow packet was received at the node. TimeStamp The seconds portion of the TIMESTAMP object. TimeStamp_usec Microseconds portion of the TIMESTAMP object. Type Type of the TIMESTAMP i.e., PTP, LCPU or NTP. IngressIFLAttribute Object representing Ingress interface attribute. L2EcmpList List of layer2 ECMP objects. NumBuckets Number of buckets in the ECMP. AE_IFL_NAME Aggregated interface name. IFLList List of interface objects. IFLName Interface name. IFLStats Object representing interface statistics. TX_PKTS Total transmit packets on the interface. RX_PKTS Total receive packets on the interface. 15

28 Cloud Analytics Engine Compute Agent API Reference Table 11: data/tunnel Resource JSON Response Elements (continued) Element TX_UCPKTS Total number of egress/transmitted unicast packets on the interface. RX_UCPKTS Total number of ingress/received unicast packets on the interface. TX_BCPKTS Total number of outgoing broadcast packets. RX_BCPKTS Total number of incoming broadcast packets. TX_MCPKTS Total outgoing multicast packets. RX_MCPKTS Total incoming multicast packets. TX_PPS Transmit bandwidth interms of packets per second. RX_PPS Receive bandwidth interms of packets per second. TX_CRCERROR Total CRC align errors on TX. RX_CRCERROR Total CRC align errors on RX. TX_DROPPKT Cumulative tx packet drop in all the queues for the interface. RX_DROPPKT Rx packet drops while ingressing the interface, reason could be buffer full etc. TX_BYTES Total transmit bytes. RX_BYTES Total receive bytes. TX_BW Transmit bandwidth (bytes per second), i.e average rate at which packet bytes are transmitted. RX_BW Receive bandwidth (bytes per second), i.e average rate at which packet bytes are received. EgressIFLAttribute Object representing Egress interface attribute. L3Ecmp Object representing layer 3 ECMP. Related Documentation Compute Agent API Resources Overview on page 3 GET list/flow Resource The GET list/flow resource returns all flows active in the kernel. Table 12 on page 17 describes the GET list/flow API resource parameters. 16

29 Chapter 2: Compute Agent API Reference Table 7 on page 9 describes the list/flow resource JSON response elements. Table 12: GET list/flow Resource Parameters List Resource Parameters GET list/flow/ Flows active in kernel Optional Returns JSON string representing all flows active in kernel. Return Codes: EFAIL Failed to fetch the data. active Return active flows for last 60 secsonds. Optional parameter Default: False. Table 13: list/flow Resource JSON Response Elements Element FLOWS Object representing application flows. SIP Source IP DIP Destination IP PROTO Protocol (tcp or udp) PORTS List of tuples. In case of non-overlay this tuple consists of timestamp, destination port, source port. In case of overlay this tuple contains the following in order: timestamp, destination port, source port, vxlan identifier, vm source mac, vm destination mac, vm source IP, vm destination IP, vm application protocol, vm application source port, vm application destination port. Related Documentation Compute Agent API Resources Overview on page 3 GET active/flow Resource The GET active/flow resource returns all flows for the originator of the request. Table 14 on page 18 describes the GET active/flow API resource parameters. 17

30 Cloud Analytics Engine Compute Agent API Reference Table 14: GET active/flow Resource Parameters Flow Resource Parameters GET active/flow/... Returns JSON string representing all flows for the originator of the request. The JSON response for this resource is a list up tuples consisting of Destination IP, Source IP, Protocol, source port, destination port. Related Documentation Compute Agent API Resources Overview on page 3 GET active/tunnel Resource The GET active/tunnel resource returns EOK if probe is active for this tunnel else returns EFAIL Table 15 on page 18 describes the GET active/tunnel API resource parameters. Table 15: GET active/tunnel Resource Parameters Tunnel Resource Parameters GET active/tunnel/... Returns JSON string representing all tunnel flows for the originator of the request. The JSON response for this resource is a list up tuples consisting of VTEP Source IP, VTEP Destination IP,.VM destination IP, VM Source IP, Vxlan ID, Outer Source port. Related Documentation Compute Agent API Resources Overview on page 3 18