Retrieves the top N application hosts.
Resource URL
/webacs/api/v1/op/statisticsService/application/topNHosts
Since : 1.2
Request Parameters
Long
|
startTime
required
|
Specifies the time to check the top N hosts from. (See 'range' for more details)
|
Long
|
endTime
required
|
Specifies the time to check the top N hosts to. (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.
|
String
|
appId
optional
|
Use to filter on a specific application by ID. Defaults to 0 which implies no filtering.
|
Integer
|
siteId
optional
|
Use to filter on a specific site by ID. Defaults to 0 which implies no filtering.
|
String
|
domainId
optional
|
Use to filter on a specific domain by ID. Only used with siteId is zero. Defaults to ROOT-DOMAIN.
|
String
|
pdsId
optional
|
Used to filter on a specific PDS by ID. If non-zero siteId is expected to be non-zero.
|
Integer
|
topN
required
|
The number of results to return.
|
String
|
trafficDir
optional
|
The direction of traffic to measure (All, In, Out). Defaults to All.
|
String
|
ipAddress
optional
|
A specific ipAddress of a device. Required when pdsId=0 and interfaceName!=null.
|
String
|
interfaceName
optional
|
An interface name on the device given by ipAddress field.
|
Integer
|
interfaceId
optional
|
A specific index of an interface . Required when pdsId=0 and interfaceName!=null.
|
String
|
sortOrder
optional
|
The sort order of the results (ASC/DESC). Defaults to DESC.
|
String
|
nwAwareValue
optional
|
Use to filter on a specific CONNECTIONTYPE.
|
String
|
ssidValue
optional
|
Use to filter on a specifc SSID.
|
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://192.168.116.207/webacs/api/v1/op/statisticsService/application/topNHosts?range=1&topN=5
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<mgmtResponse rootUrl="https://192.168.116.207/webacs/api/v1/op/statisticsService/application/statisticsService/application/topNHosts" requestUrl="https://192.168.116.207/webacs/api/v1/op/statisticsService/application/topNHosts?range=1&topN=5" 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://192.168.116.207/webacs/api/v1/op/statisticsService/application/topNHosts?range=1&topN=5.json
{
"mgmtResponse" : {
"@rootUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/op\/statisticsService\/application\/statisticsService\/application\/topNHosts",
"@requestUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/op\/statisticsService\/application\/topNHosts?range=1&topN=5",
"@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"
}
}
}