Flow Data - Time Series History - RESTful API

Summary:

List time series by flow data, grouped and filtered according to query parameters.

URL:

http(s)://{server hostname}/api/flowHistory

Methods summary

GET Method detail

Methods summary

• GET Method details - lists time series by flow data.

GET Method detail

List time series by flow data.

Examples:

Total traffic for deviceID 1 at 5 minute intervals in last 30 minutes:

INPUT
curl -u admin:admin https://localhost/api/flowHistory/1?media=xml&startTime=-1800&interval=300

OUTPUT
<?xml version="1.0" encoding="UTF-8" standalone="true"?>
<ns2:flowHistoryResult xmlns:ns2="https://www.entuity.com/schemas/flow">
  <sampleSet> 
    <sample rate="9323.48" timestamp="1507541700" volume="2797044"/>
    <sample rate="12137.806666666667" timestamp="1507542000" volume="3641342"/>
    <sample rate="9914.983333333334" timestamp="1507542300" volume="2974495"/>
    <sample rate=8400.313333333334" timestamp="1507542600" volume="2520094"/>
    <sample rate="8922.28" timestamp="1507542900" volume="2676684"/>
  </sampleSet>
</ns2:flowHistoryResult>

Grouped by ingress interface:

INPUT
curl -u admin:admin https://localhost/api/flowHistory/1?media=xml&startTime=-900&interval=300&groups=ifIn

OUTPUT
<?xml version="1.0" encoding="UTF-8" standalone="true"?>
<ns2:flowHistoryResult xmlns:ns2="https://www.entuity.com/schemas/flow">
  <sampleSet>   
    <key>5</key>
    <sample rate="5446.903333333334" timestamp="1507543200" volume="1634071"/>
    <sample rate="4787.08" timestamp="1507543500" volume="1436124"/>
  </sampleSet>      
  <sampleSet>
    <key>7</key>
    <sample rate="3815.54" timestamp="1507543200" volume="1144662"/>
    <sample rate="3208.3" timestamp="1507543500" volume="962490"/>
  </sampleSet>
</ns2:flowHistoryResult>

Grouped by egress interface:

INPUT
curl -u admin:admin https://localhost/api/flowHistory/1?media=xml&startTime=-900&interval=300&groups=ifOut

OUTPUT
<?xml version="1.0" encoding="UTF-8" standalone="true"?>
<ns2:flowHistoryResult xmlns:ns2="https://www.entuity.com/schemas/flow">
  <sampleSet>
    <key>0</key>
    <sample rate="1959.3333333333333" timestamp="1507543500" volume="587800"/>
    <sample rate="1614.19" timestamp="1507543800" volume="484257"/>
 </sampleSet>
 <sampleSet>
    <key>5</key>
    <sample rate="3177.6666666666665" timestamp="1507543500" volume="953300"/>
    <sample rate="4375.68" timestamp="1507543800" volume="1312704"/>
  </sampleSet>   
  <sampleSet>
    <key>7</key>
    <sample rate="2858.38" timestamp="1507543500" volume="857514"/>
    <sample rate="3881.9966666666664" timestamp="1507543800" volume="1164599"/>
  </sampleSet>
</ns2:flowHistoryResult>    

Grouped by interface (note the double counting):

INPUT
curl -u admin:admin https://localhost/api/flowHistory/1?media=xml&startTime=-900&interval=300&groups=if

OUTPUT
<?xml version="1.0" encoding="UTF-8" standalone="true"?>
<ns2:flowHistoryResult xmlns:ns2="https://www.entuity.com/schemas/flow">
  <sampleSet>
    <key>0</key>
    <sample rate="1614.19" timestamp="1507543800" volume="484257"/>
    <sample rate="2288.0533333333333" timestamp="1507544100" volume="686416"/>
  </sampleSet>
  <sampleSet>
    <key>5</key>
    <sample rate="9842.563333333334" timestamp="1507543800" volume="2952769"/>
    <sample rate="10004.85" timestamp="1507544100" volume="3001455"/>
  </sampleSet>
  <sampleSet>
    <key>7</key>
    <sample rate="8286.98" timestamp="1507543800" volume="2486094"/>
    <sample rate="7776.736666666667" timestamp="1507544100" volume="2333021"/>
  </sampleSet>
</ns2:flowHistoryResult>

Grouped by application and sender. Restricted to limited set of applications and IP subnet :

INPUT
curl -u admin:admin https://localhost/api/flowHistory/1?media=xml&startTime=-900&interval=300&groups=appName,srcIP&filter=AND(OR(OR(EQ(appName,ICMP),EQ(appName,snmp)),EQ(appName,smtp)),LIKE(srcIP,10.44.2.*))  

OUTPUT
<?xml version="1.0" encoding="UTF-8" standalone="true"?>
<ns2:flowHistoryResult xmlns:ns2="https://www.entuity.com/schemas/flow">
  <sampleSet>
    <key>ICMP </key>
    <key>10.44.2.10</key>
    <sample rate="0.32" timestamp="1507559400" volume="96"/>
    <sample rate="0.48" timestamp="1507559700" volume="144"/>
  </sampleSet>
  <sampleSet>
    <key>ICMP</key>
    <key>10.44.2.76</key>
    <sample rate="0.32" timestamp="1507559400" volume="96"/>
    <sample rate="0.48" timestamp="1507559700" volume="144"/>
  </sampleSet>
  <sampleSet>
    <key>smtp</key>
    <key>10.44.2.130</key>
    <sample rate="1.0133333333333334" timestamp="1507559400" volume="304"/>
    <sample rate="1.52" timestamp="1507559700" volume="456"/>
  </sampleSet> 
  <sampleSet>
    <key>snmp</key>
    <key>10.44.2.122</key>
mp="1507559400" volume="42278"/>
    <sample rate="160.25" timestamp="1507559700" volume="48075"/>
  </sampleSet>
</ns2:flowHistoryResult>