Since Product Version: 1.2
Resource URL
/webacs/api/v1/op/statisticsService/interface/topNUtilRequest Parameters
Type | Attribute Name | Source | Description |
---|---|---|---|
Long |
startTime required |
query |
Specifies the start time in seconds to check the top N statistics. (See 'range' for more details) |
Long |
endTime required |
query |
Specifies the end time in seconds to check the top N statistics. (See 'range' for more details) |
Integer |
range required |
query |
Specifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters. |
Integer |
topN required |
query |
The number of top interfaces to get. |
String |
source optional |
query |
An optional filter parameter that can be used to provide the IP Address or a group ID to get a filtered response. |
String |
utilType optional |
query |
The utilization type to get the Top N Interface utilization summary for. Possible Values: tx, rx. By default, when not specified, it defaults to a result that uses a combined average of tx and rx results. |
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/interface/topNUtil?range=1&topN=5
<?xml version="1.0" ?> <mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v1/op/statisticsService/interface/topNUtil?range=1&amp;topN=5" 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/interface/topNUtil.json?range=1&topN=5
{ "mgmtResponse" : { "@responseType" : "operation", "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/statisticsService\/interface\/topNUtil?range=1&topN=5", "@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" } } }