- /op/statisticsService/application/topNTraffics -- return the top 15 client traffics of all applications in the past 1 hour
- /op/statisticsService/application/topNTraffics?nodeType=server -- return the top 15 server traffics of all applications in the past 1 hour
- /op/statisticsService/application/topNTraffics?networkAwareType=2 -- return the top 15 client wired traffics of all applications in the past 1 hour
- /op/statisticsService/application/topNTraffics?appId=1234 -- return the top 15 client traffics of the application with id 1234 in the past 1 hour
- /op/statisticsService/application/topNTraffics?appId=1234,5678 -- return the top 15 client traffics of of the application with id 1234 and 5678 in the past 1 hour
Since Product Version: 1.2
Resource URL
/webacs/api/v1/op/statisticsService/application/topNTrafficsRequest Parameters
Type | Attribute Name | Source | Description |
---|---|---|---|
Integer |
range optional |
query |
Specifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1 week), 336(2 week), 720 (1 month). The default ivalue s 1 which is the last 1 hour |
Long |
startTime optional |
query |
Specifies the time to start from. (See 'range' for more details) |
Long |
endTime optional |
query |
Specifies the time to check to. (See 'range' for more details) |
String |
trafficDirection optional |
query |
Traffic directions. The value could be All,In,Out. The default is All |
String |
siteId optional |
query |
Use to filter on a specific site by ID |
String |
dataSourceId optional |
query |
|
String |
deviceIp optional |
query |
Device Ip address |
String |
interfaceId optional |
query |
|
Integer |
interfaceIndex optional |
query |
To filter by interfaceIndex, the deviceIp needs to be provided |
String |
sortOrder optional |
query |
Values could be DESC/ASC, The default value is DESC |
String |
appId optional |
query |
The application Id. Use comma to seperate multiple ids. |
Integer |
topN optional |
query |
The default value is 15 |
String |
clientIp optional |
query |
Client Ip address |
String |
networkAwareType optional |
query |
Values could be 1 (wireless), 2 (wired). When no value is specified, both wireless and wired will be returned |
String |
dataType optional |
query |
Values could be rate(bytes/second) or volume(bytes), The default value is volume |
String |
nodeType optional |
query |
Values could be client or server. The default value is client |
Response Parameters
Type | Attribute Name | Description |
---|---|---|
childStatistics |
The set of nested StatisticsDTO objects. |
|
statisticEntry |
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics. |
|
StatisticsOperationTypeEnum |
statisticsName |
The Statistics operation type. Allowed values:
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://172.25.123.114/webacs/api/v1/op/statisticsService/application/topNTraffics
<?xml version="1.0" ?> <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://172.25.123.114/webacs/api/v1/op/"> <statisticsDTO> <childStatistics> <childStatistic> <childStatistics> <childStatistic> <childStatistics> <childStatistic> <childStatistics> <childStatistic> <statisticEntries> <statisticEntry> <attributeName>String value</attributeName> <displayName>String value</displayName> <entryValue>String value</entryValue> </statisticEntry> </statisticEntries> <statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName> </childStatistic> </childStatistics> <statisticEntries> <statisticEntry> <attributeName>String value</attributeName> <displayName>String value</displayName> <entryValue>String value</entryValue> </statisticEntry> </statisticEntries> <statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName> </childStatistic> </childStatistics> <statisticEntries> <statisticEntry> <attributeName>String value</attributeName> <displayName>String value</displayName> <entryValue>String value</entryValue> </statisticEntry> </statisticEntries> <statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName> </childStatistic> </childStatistics> <statisticEntries> <statisticEntry> <attributeName>String value</attributeName> <displayName>String value</displayName> <entryValue>String value</entryValue> </statisticEntry> </statisticEntries> <statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName> </childStatistic> </childStatistics> <statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName> </statisticsDTO> </mgmtResponse>
Sample JSON Response Payload
https://172.25.123.114/webacs/api/v1/op/statisticsService/application/topNTraffics.json
{ "mgmtResponse" : { "@responseType" : "operation", "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/statisticsService\/application\/topNTraffics", "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/", "statisticsDTO" : { "childStatistics" : { "childStatistic" : { "childStatistics" : { "childStatistic" : { "childStatistics" : { "childStatistic" : { "childStatistics" : { "childStatistic" : { "statisticEntries" : { "statisticEntry" : { "attributeName" : "String value", "displayName" : "String value", "entryValue" : "String value" } }, "statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION" } }, "statisticEntries" : { "statisticEntry" : { "attributeName" : "String value", "displayName" : "String value", "entryValue" : "String value" } }, "statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION" } }, "statisticEntries" : { "statisticEntry" : { "attributeName" : "String value", "displayName" : "String value", "entryValue" : "String value" } }, "statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION" } }, "statisticEntries" : { "statisticEntry" : { "attributeName" : "String value", "displayName" : "String value", "entryValue" : "String value" } }, "statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION" } }, "statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION" } } }