404
edits
REST API description: Difference between revisions
→JSON output traffic counters
| Line 181: | Line 181: | ||
All counters are aggregated counters, either for the selected time interval or since the processing start of the Allegro. Many traffic counters have 4 separate values. These traffic counters are represented as a JSON array with at least 4 lines. The structure is as follows: | All counters are aggregated counters, either for the selected time interval or since the processing start of the Allegro. Many traffic counters have 4 separate values. These traffic counters are represented as a JSON array with at least 4 lines. The structure is as follows: | ||
* line 1: received packets. | * line 1: '''received packets''', extraction example: jq .lastSecond[0] | ||
* line 2: received bytes. | * line 2: '''received bytes''', extraction example: jq .lastSecond[1] | ||
* line 3: transmitted packets. | * line 3: '''transmitted packets''', extraction example: jq .lastSecond[2] | ||
* line 4: transmitted bytes. | * line 4: '''transmitted bytes''', extraction example: jq .lastSecond[3] | ||
* other lines are module specific | * other lines are module specific | ||
The following counters | The following counters exist for many REST APIs like IP, MAC, l4 protocol, l7 protocol and many more: | ||
* interval: Values of the selected time interval. If no interval is specified, this is similar to lastSecond. | * '''interval''': Values of the selected time interval. If no interval is specified, this is similar to lastSecond. | ||
* allTime: Values since start of the Allegro Network Multimeter. | * '''allTime''': Values since start of the Allegro Network Multimeter. | ||
* lastSecond: Values of the last second. | * '''lastSecond''': Values of the last second. | ||
* intervalPerSecond: Average per second value of the selected time interval. If no interval is specified, this is similar to lastSecond. | * '''intervalPerSecond''': Average per second value of the selected time interval. If no interval is specified, this is similar to lastSecond. | ||
Please note that all counters are Byte counters, not bit counters. You need to multiply the counters by 8 to get the bitrate. | Please note that all counters are Byte counters, not bit counters. You need to multiply the counters by 8 to get the bitrate. | ||