Retrieves the top N class map QOS statistics.
Resource URL
/webacs/api/v1/op/statisticsService/interface/topNClassMapQOS
Request Parameters
Long
|
startTime
required
|
Specifies the start time in seconds to check the top N statistics. (See 'range' for more details)
|
Long
|
endTime
required
|
Specifies the end time in seconds to check the top N statistics. (See 'range' for more details)
|
Integer
|
range
required
|
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
|
The number of top interfaces to get.
|
String
|
source
optional
|
An optional filter parameter that can be used to provide the IP Address or a group ID to get a filtered response.
|
String
|
ifIndex
required
|
The ifIndex of the interface to be used in the query.
|
Response Parameters
A common response format is used across all statistics services of the Prime Infrastructure API. Please refer to the
statistics response format section for details and samples.
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://10.194.172.75/webacs/api/v1/op/statisticsService/interface/topNClassMapQOS?range=1&topN=5&ifIndex=0
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<mgmtResponse rootUrl="https://10.194.172.75/webacs/api/v1/op/statisticsService/interface/statisticsService/interface/topNClassMapQOS" requestUrl="https://10.194.172.75/webacs/api/v1/op/statisticsService/interface/topNClassMapQOS?range=1&topN=5&ifIndex=0" responseType="operation">
<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://10.194.172.75/webacs/api/v1/op/statisticsService/interface/topNClassMapQOS?range=1&topN=5&ifIndex=0.json
{
"mgmtResponse" : {
"@rootUrl" : "https : \/\/10.194.172.75\/webacs\/api\/v1\/op\/statisticsService\/interface\/statisticsService\/interface\/topNClassMapQOS",
"@requestUrl" : "https : \/\/10.194.172.75\/webacs\/api\/v1\/op\/statisticsService\/interface\/topNClassMapQOS?range=1&topN=5&ifIndex=0",
"@responseType" : "operation",
"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"
}
}
}