Retrieves the top N application hosts.
Since Product Version: 1.2
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/statisticsService/application/topNHosts
Request Parameters
startTime
Long
|
query
|
RequiredSpecifies the time to check the top N hosts from. (See 'range' for more details)
|
endTime
Long
|
query
|
RequiredSpecifies the time to check the top N hosts to. (See 'range' for more details)
|
range
Integer
|
query
|
RequiredSpecifies 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.
|
appId
String
|
query
|
OptionalUse to filter on a specific application by ID. If not specified then statistics for all applications will be returned.
|
siteId
Integer
|
query
|
OptionalUse to filter on a specific site by ID. If not specified then statistics for all sites will be returned.
|
domainId
String
|
query
|
OptionalUse to filter on a specific domain by ID. Only used with siteId is zero. Defaults to ROOT-DOMAIN.
|
pdsId
String
|
query
|
OptionalUse to filter on a specific data source by ID. If not specified then statistics for all data sources will be returned.
|
topN
Integer
|
query
|
RequiredThe number of results to return.
|
trafficDir
String
|
query
|
OptionalThe direction of traffic to measure (All, In, Out). Defaults to All.
|
ipAddress
String
|
query
|
OptionalA specific ipAddress of a device. Required when pdsId=0 and interfaceName!=null.
|
interfaceName
String
|
query
|
OptionalAn interface name on the device given by ipAddress field.
|
interfaceId
Integer
|
query
|
OptionalA specific index of an interface . Required when pdsId=0 and interfaceName!=null.
|
sortOrder
String
|
query
|
OptionalThe sort order of the results (ASC/DESC). Defaults to DESC.
|
nwAwareValue
String
|
query
|
OptionalUse to filter on a specific connection type. If not specified then statistics for all connection types will be returned.
|
ssidValue
String
|
query
|
OptionalUse to filter on a specific SSID. If not specified then statistics for all SSID will be returned.
|
Response Parameters
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
Allowed values:
- DEVICE_TOPN_CPU_UTILIZATION
- DEVICE_TOPN_MEMORY_UTILIZATION
- DEVICE_TOPN_TEMPERATURE
- DEVICE_AVAILABILITY
- DEVICE_AVAILABILITY_SUMMARY
- DEVICE_CPU_UTILIZATION_TREND
- DEVICE_MEMORY_UTILIZATION_TREND
- DEVICE_HEALTH_INFO
- DEVICE_REACHABILITY_STATUS
- DEVICE_PORT_SUMMARY
- DEVICE_AVAILABILITY_MESSAGE
- DEVICE_DOWN_MESSAGE
- DEVICE_CPU_UTILIZATION_SUMMARY
- INTERFACE_AVAILABILITY
- INTERFACE_DETAILS
- INTERFACE_OUT_ERRORS
- INTERFACE_DISCARDS
- INTERFACE_UTILIZATION
- INTERFACE_TOPN_UTILIZATION
- INTERFACE_TOPN_ERRORS
- INTERFACE_TOPN_WAN_UTILIZATION
- INTERFACE_UTILIZATION_SUMMARY
- INTERFACE_AVAILABILITY_SUMMARY
- INTERFACE_STATUS_SUMMARY
- INTERFACE_AVAILABILITY_MESSAGE
- INTERFACE_DOWN_MESSAGE
- INTERFACE_TOPN_WAN_ISSUES
- INTERFACE_CLASSMAP_QOS
- APPLICATION_TOPN_WORST_HOSTS
- APPLICATION_TOPN_WORST_SITES
- APPLICATION_TOPN_HOSTS
- APPLICATION_TOPN_APP_PERFORMANCE
- APPLICATION_TOPN_TRAFFIC_ANALYSIS
- APPLICATION_NUMBER_OF_USERS
- SYSTEM_INFO
- SYSTEM_HEALTH
- APPLICATION_VOLUME
- APPLICATION_ART_ANALYSIS
- APPLICATION_TOPN_TRAFFICS
- APPLICATION_TOPN_WITH_SITES
|
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
Allowed values:
- DEVICE_TOPN_CPU_UTILIZATION
- DEVICE_TOPN_MEMORY_UTILIZATION
- DEVICE_TOPN_TEMPERATURE
- DEVICE_AVAILABILITY
- DEVICE_AVAILABILITY_SUMMARY
- DEVICE_CPU_UTILIZATION_TREND
- DEVICE_MEMORY_UTILIZATION_TREND
- DEVICE_HEALTH_INFO
- DEVICE_REACHABILITY_STATUS
- DEVICE_PORT_SUMMARY
- DEVICE_AVAILABILITY_MESSAGE
- DEVICE_DOWN_MESSAGE
- DEVICE_CPU_UTILIZATION_SUMMARY
- INTERFACE_AVAILABILITY
- INTERFACE_DETAILS
- INTERFACE_OUT_ERRORS
- INTERFACE_DISCARDS
- INTERFACE_UTILIZATION
- INTERFACE_TOPN_UTILIZATION
- INTERFACE_TOPN_ERRORS
- INTERFACE_TOPN_WAN_UTILIZATION
- INTERFACE_UTILIZATION_SUMMARY
- INTERFACE_AVAILABILITY_SUMMARY
- INTERFACE_STATUS_SUMMARY
- INTERFACE_AVAILABILITY_MESSAGE
- INTERFACE_DOWN_MESSAGE
- INTERFACE_TOPN_WAN_ISSUES
- INTERFACE_CLASSMAP_QOS
- APPLICATION_TOPN_WORST_HOSTS
- APPLICATION_TOPN_WORST_SITES
- APPLICATION_TOPN_HOSTS
- APPLICATION_TOPN_APP_PERFORMANCE
- APPLICATION_TOPN_TRAFFIC_ANALYSIS
- APPLICATION_NUMBER_OF_USERS
- SYSTEM_INFO
- SYSTEM_HEALTH
- APPLICATION_VOLUME
- APPLICATION_ART_ANALYSIS
- APPLICATION_TOPN_TRAFFICS
- APPLICATION_TOPN_WITH_SITES
|
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://localhost/webacs/api/v1/op/statisticsService/application/topNHosts?range=1&topN=5
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/statisticsService/application/topNHosts?range=1&amp;topN=5" rootUrl="https://localhost/webacs/api/v1/op">
<statisticsDTO>
<childStatistics></childStatistics>
<statisticEntries>
<statisticEntry>
<attributeName>String value</attributeName>
<displayName>String value</displayName>
<entryValue>String value</entryValue>
</statisticEntry>
</statisticEntries>
<statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
</statisticsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v1/op/statisticsService/application/topNHosts.json?range=1&topN=5
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/statisticsService\/application\/topNHosts?range=1&topN=5",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"statisticsDTO" : {
"childStatistics" : "",
"statisticEntries" : {
"statisticEntry" : {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
}
},
"statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
}
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/statisticsService/application/topNHosts
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
startTime
Long
|
query
|
RequiredSpecifies the time to check the top N hosts from. (See 'range' for more details)
|
endTime
Long
|
query
|
RequiredSpecifies the time to check the top N hosts to. (See 'range' for more details)
|
range
Integer
|
query
|
RequiredSpecifies 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.
|
appId
String
|
query
|
OptionalUse to filter on a specific application by ID. If not specified then statistics for all applications will be returned.
|
siteId
Integer
|
query
|
OptionalUse to filter on a specific site by ID. If not specified then statistics for all sites will be returned.
|
domainId
String
|
query
|
OptionalUse to filter on a specific domain by ID. Only used with siteId is zero. Defaults to ROOT-DOMAIN.
|
pdsId
String
|
query
|
OptionalUse to filter on a specific data source by ID. If not specified then statistics for all data sources will be returned.
|
topN
Integer
|
query
|
RequiredThe number of results to return.
|
trafficDir
String
|
query
|
OptionalThe direction of traffic to measure (All, In, Out). Defaults to All.
|
ipAddress
String
|
query
|
OptionalA specific ipAddress of a device. Required when pdsId=0 and interfaceName!=null.
|
interfaceName
String
|
query
|
OptionalAn interface name on the device given by ipAddress field.
|
interfaceId
Integer
|
query
|
OptionalA specific index of an interface . Required when pdsId=0 and interfaceName!=null.
|
sortOrder
String
|
query
|
OptionalThe sort order of the results (ASC/DESC). Defaults to DESC.
|
nwAwareValue
String
|
query
|
OptionalUse to filter on a specific connection type. If not specified then statistics for all connection types will be returned.
|
ssidValue
String
|
query
|
OptionalUse to filter on a specific SSID. If not specified then statistics for all SSID will be returned.
|
Response Parameters
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
Allowed values:
- DEVICE_TOPN_CPU_UTILIZATION
- DEVICE_TOPN_MEMORY_UTILIZATION
- DEVICE_TOPN_TEMPERATURE
- DEVICE_AVAILABILITY
- DEVICE_AVAILABILITY_SUMMARY
- DEVICE_CPU_UTILIZATION_TREND
- DEVICE_MEMORY_UTILIZATION_TREND
- DEVICE_HEALTH_INFO
- DEVICE_REACHABILITY_STATUS
- DEVICE_PORT_SUMMARY
- DEVICE_AVAILABILITY_MESSAGE
- DEVICE_DOWN_MESSAGE
- DEVICE_CPU_UTILIZATION_SUMMARY
- INTERFACE_AVAILABILITY
- INTERFACE_DETAILS
- INTERFACE_OUT_ERRORS
- INTERFACE_DISCARDS
- INTERFACE_UTILIZATION
- INTERFACE_TOPN_UTILIZATION
- INTERFACE_TOPN_ERRORS
- INTERFACE_TOPN_WAN_UTILIZATION
- INTERFACE_UTILIZATION_SUMMARY
- INTERFACE_AVAILABILITY_SUMMARY
- INTERFACE_STATUS_SUMMARY
- INTERFACE_AVAILABILITY_MESSAGE
- INTERFACE_DOWN_MESSAGE
- INTERFACE_TOPN_WAN_ISSUES
- INTERFACE_CLASSMAP_QOS
- APPLICATION_TOPN_WORST_HOSTS
- APPLICATION_TOPN_WORST_SITES
- APPLICATION_TOPN_HOSTS
- APPLICATION_TOPN_APP_PERFORMANCE
- APPLICATION_TOPN_TRAFFIC_ANALYSIS
- APPLICATION_NUMBER_OF_USERS
- SYSTEM_INFO
- SYSTEM_HEALTH
- APPLICATION_VOLUME
- APPLICATION_ART_ANALYSIS
- APPLICATION_TOPN_TRAFFICS
- APPLICATION_TOPN_WITH_SITES
|
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
Allowed values:
- DEVICE_TOPN_CPU_UTILIZATION
- DEVICE_TOPN_MEMORY_UTILIZATION
- DEVICE_TOPN_TEMPERATURE
- DEVICE_AVAILABILITY
- DEVICE_AVAILABILITY_SUMMARY
- DEVICE_CPU_UTILIZATION_TREND
- DEVICE_MEMORY_UTILIZATION_TREND
- DEVICE_HEALTH_INFO
- DEVICE_REACHABILITY_STATUS
- DEVICE_PORT_SUMMARY
- DEVICE_AVAILABILITY_MESSAGE
- DEVICE_DOWN_MESSAGE
- DEVICE_CPU_UTILIZATION_SUMMARY
- INTERFACE_AVAILABILITY
- INTERFACE_DETAILS
- INTERFACE_OUT_ERRORS
- INTERFACE_DISCARDS
- INTERFACE_UTILIZATION
- INTERFACE_TOPN_UTILIZATION
- INTERFACE_TOPN_ERRORS
- INTERFACE_TOPN_WAN_UTILIZATION
- INTERFACE_UTILIZATION_SUMMARY
- INTERFACE_AVAILABILITY_SUMMARY
- INTERFACE_STATUS_SUMMARY
- INTERFACE_AVAILABILITY_MESSAGE
- INTERFACE_DOWN_MESSAGE
- INTERFACE_TOPN_WAN_ISSUES
- INTERFACE_CLASSMAP_QOS
- APPLICATION_TOPN_WORST_HOSTS
- APPLICATION_TOPN_WORST_SITES
- APPLICATION_TOPN_HOSTS
- APPLICATION_TOPN_APP_PERFORMANCE
- APPLICATION_TOPN_TRAFFIC_ANALYSIS
- APPLICATION_NUMBER_OF_USERS
- SYSTEM_INFO
- SYSTEM_HEALTH
- APPLICATION_VOLUME
- APPLICATION_ART_ANALYSIS
- APPLICATION_TOPN_TRAFFICS
- APPLICATION_TOPN_WITH_SITES
|
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://localhost/webacs/api/v2/op/statisticsService/application/topNHosts?range=1&topN=5
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/statisticsService/application/topNHosts?range=1&amp;topN=5" rootUrl="https://localhost/webacs/api/v2/op">
<statisticsDTO>
<childStatistics></childStatistics>
<statisticEntries>
<statisticEntry>
<attributeName>String value</attributeName>
<displayName>String value</displayName>
<entryValue>String value</entryValue>
</statisticEntry>
</statisticEntries>
<statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
</statisticsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/statisticsService/application/topNHosts.json?range=1&topN=5
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/statisticsService/application/topNHosts?range=1&topN=5",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"statisticsDTO" : [ {
"childStatistics" : {
"childStatistic" : [ ]
},
"statisticEntries" : {
"statisticEntry" : [ {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
} ]
},
"statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/statisticsService/application/topNHosts
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
startTime
Long
|
query
|
RequiredSpecifies the time to check the top N hosts from. (See 'range' for more details)
|
endTime
Long
|
query
|
RequiredSpecifies the time to check the top N hosts to. (See 'range' for more details)
|
range
Integer
|
query
|
RequiredSpecifies 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.
|
appId
String
|
query
|
OptionalUse to filter on a specific application by ID. If not specified then statistics for all applications will be returned.
|
siteId
Integer
|
query
|
OptionalUse to filter on a specific site by ID. If not specified then statistics for all sites will be returned.
|
domainId
String
|
query
|
OptionalUse to filter on a specific domain by ID. Only used with siteId is zero. Defaults to ROOT-DOMAIN.
|
pdsId
String
|
query
|
OptionalUse to filter on a specific data source by ID. If not specified then statistics for all data sources will be returned.
|
topN
Integer
|
query
|
RequiredThe number of results to return.
|
trafficDir
String
|
query
|
OptionalThe direction of traffic to measure (All, In, Out). Defaults to All.
|
ipAddress
String
|
query
|
OptionalA specific ipAddress of a device. Required when pdsId=0 and interfaceName!=null.
|
interfaceName
String
|
query
|
OptionalAn interface name on the device given by ipAddress field.
|
interfaceId
Integer
|
query
|
OptionalA specific index of an interface . Required when pdsId=0 and interfaceName!=null.
|
sortOrder
String
|
query
|
OptionalThe sort order of the results (ASC/DESC). Defaults to DESC.
|
nwAwareValue
String
|
query
|
OptionalUse to filter on a specific connection type. If not specified then statistics for all connection types will be returned.
|
ssidValue
String
|
query
|
OptionalUse to filter on a specific SSID. If not specified then statistics for all SSID will be returned.
|
Response Parameters
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
Allowed values:
- DEVICE_TOPN_CPU_UTILIZATION
- DEVICE_TOPN_MEMORY_UTILIZATION
- DEVICE_TOPN_TEMPERATURE
- DEVICE_AVAILABILITY
- DEVICE_AVAILABILITY_SUMMARY
- DEVICE_CPU_UTILIZATION_TREND
- DEVICE_MEMORY_UTILIZATION_TREND
- DEVICE_HEALTH_INFO
- DEVICE_REACHABILITY_STATUS
- DEVICE_PORT_SUMMARY
- DEVICE_AVAILABILITY_MESSAGE
- DEVICE_DOWN_MESSAGE
- DEVICE_CPU_UTILIZATION_SUMMARY
- INTERFACE_AVAILABILITY
- INTERFACE_DETAILS
- INTERFACE_OUT_ERRORS
- INTERFACE_DISCARDS
- INTERFACE_UTILIZATION
- INTERFACE_TOPN_UTILIZATION
- INTERFACE_TOPN_ERRORS
- INTERFACE_TOPN_WAN_UTILIZATION
- INTERFACE_UTILIZATION_SUMMARY
- INTERFACE_AVAILABILITY_SUMMARY
- INTERFACE_STATUS_SUMMARY
- INTERFACE_AVAILABILITY_MESSAGE
- INTERFACE_DOWN_MESSAGE
- INTERFACE_TOPN_WAN_ISSUES
- INTERFACE_CLASSMAP_QOS
- APPLICATION_TOPN_WORST_HOSTS
- APPLICATION_TOPN_WORST_SITES
- APPLICATION_TOPN_HOSTS
- APPLICATION_TOPN_APP_PERFORMANCE
- APPLICATION_TOPN_TRAFFIC_ANALYSIS
- APPLICATION_NUMBER_OF_USERS
- SYSTEM_INFO
- SYSTEM_HEALTH
- APPLICATION_VOLUME
- APPLICATION_ART_ANALYSIS
- APPLICATION_TOPN_TRAFFICS
- APPLICATION_TOPN_WITH_SITES
|
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
Allowed values:
- DEVICE_TOPN_CPU_UTILIZATION
- DEVICE_TOPN_MEMORY_UTILIZATION
- DEVICE_TOPN_TEMPERATURE
- DEVICE_AVAILABILITY
- DEVICE_AVAILABILITY_SUMMARY
- DEVICE_CPU_UTILIZATION_TREND
- DEVICE_MEMORY_UTILIZATION_TREND
- DEVICE_HEALTH_INFO
- DEVICE_REACHABILITY_STATUS
- DEVICE_PORT_SUMMARY
- DEVICE_AVAILABILITY_MESSAGE
- DEVICE_DOWN_MESSAGE
- DEVICE_CPU_UTILIZATION_SUMMARY
- INTERFACE_AVAILABILITY
- INTERFACE_DETAILS
- INTERFACE_OUT_ERRORS
- INTERFACE_DISCARDS
- INTERFACE_UTILIZATION
- INTERFACE_TOPN_UTILIZATION
- INTERFACE_TOPN_ERRORS
- INTERFACE_TOPN_WAN_UTILIZATION
- INTERFACE_UTILIZATION_SUMMARY
- INTERFACE_AVAILABILITY_SUMMARY
- INTERFACE_STATUS_SUMMARY
- INTERFACE_AVAILABILITY_MESSAGE
- INTERFACE_DOWN_MESSAGE
- INTERFACE_TOPN_WAN_ISSUES
- INTERFACE_CLASSMAP_QOS
- APPLICATION_TOPN_WORST_HOSTS
- APPLICATION_TOPN_WORST_SITES
- APPLICATION_TOPN_HOSTS
- APPLICATION_TOPN_APP_PERFORMANCE
- APPLICATION_TOPN_TRAFFIC_ANALYSIS
- APPLICATION_NUMBER_OF_USERS
- SYSTEM_INFO
- SYSTEM_HEALTH
- APPLICATION_VOLUME
- APPLICATION_ART_ANALYSIS
- APPLICATION_TOPN_TRAFFICS
- APPLICATION_TOPN_WITH_SITES
|
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://localhost/webacs/api/v3/op/statisticsService/application/topNHosts?range=1&topN=5
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/statisticsService/application/topNHosts?range=1&amp;topN=5" rootUrl="https://localhost/webacs/api/v3/op">
<statisticsDTO>
<childStatistics></childStatistics>
<statisticEntries>
<statisticEntry>
<attributeName>String value</attributeName>
<displayName>String value</displayName>
<entryValue>String value</entryValue>
</statisticEntry>
<statisticEntry>
<attributeName>Another string value</attributeName>
<displayName>Another string value</displayName>
<entryValue>Another string value</entryValue>
</statisticEntry>
</statisticEntries>
<statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
</statisticsDTO>
<statisticsDTO>
<childStatistics></childStatistics>
<statisticEntries>
<statisticEntry>
<attributeName>String value</attributeName>
<displayName>String value</displayName>
<entryValue>String value</entryValue>
</statisticEntry>
<statisticEntry>
<attributeName>Another string value</attributeName>
<displayName>Another string value</displayName>
<entryValue>Another string value</entryValue>
</statisticEntry>
</statisticEntries>
<statisticsName>DEVICE_TOPN_MEMORY_UTILIZATION</statisticsName>
</statisticsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/statisticsService/application/topNHosts.json?range=1&topN=5
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/statisticsService/application/topNHosts?range=1&topN=5",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"statisticsDTO" : [ {
"childStatistics" : {
"childStatistic" : [ ]
},
"statisticEntries" : {
"statisticEntry" : [ {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
}, {
"attributeName" : "Another string value",
"displayName" : "Another string value",
"entryValue" : "Another string value"
} ]
},
"statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
}, {
"childStatistics" : {
"childStatistic" : [ ]
},
"statisticEntries" : {
"statisticEntry" : [ {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
}, {
"attributeName" : "Another string value",
"displayName" : "Another string value",
"entryValue" : "Another string value"
} ]
},
"statisticsName" : "DEVICE_TOPN_MEMORY_UTILIZATION"
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/statisticsService/application/topNHosts
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
startTime
Long
|
query
|
RequiredSpecifies the time to check the top N hosts from. (See 'range' for more details)
|
endTime
Long
|
query
|
RequiredSpecifies the time to check the top N hosts to. (See 'range' for more details)
|
range
Integer
|
query
|
RequiredSpecifies 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.
|
appId
String
|
query
|
OptionalUse to filter on a specific application by ID. If not specified then statistics for all applications will be returned.
|
siteId
Integer
|
query
|
OptionalUse to filter on a specific site by ID. If not specified then statistics for all sites will be returned.
|
domainId
String
|
query
|
OptionalUse to filter on a specific domain by ID. Only used with siteId is zero. Defaults to ROOT-DOMAIN.
|
pdsId
String
|
query
|
OptionalUse to filter on a specific data source by ID. If not specified then statistics for all data sources will be returned.
|
topN
Integer
|
query
|
RequiredThe number of results to return.
|
trafficDir
String
|
query
|
OptionalThe direction of traffic to measure (All, In, Out). Defaults to All.
|
ipAddress
String
|
query
|
OptionalA specific ipAddress of a device. Required when pdsId=0 and interfaceName!=null.
|
interfaceName
String
|
query
|
OptionalAn interface name on the device given by ipAddress field.
|
interfaceId
Integer
|
query
|
OptionalA specific index of an interface . Required when pdsId=0 and interfaceName!=null.
|
sortOrder
String
|
query
|
OptionalThe sort order of the results (ASC/DESC). Defaults to DESC.
|
nwAwareValue
String
|
query
|
OptionalUse to filter on a specific connection type. If not specified then statistics for all connection types will be returned.
|
ssidValue
String
|
query
|
OptionalUse to filter on a specific SSID. If not specified then statistics for all SSID will be returned.
|
Response Parameters
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
Allowed values:
- DEVICE_TOPN_CPU_UTILIZATION
- DEVICE_TOPN_MEMORY_UTILIZATION
- DEVICE_TOPN_TEMPERATURE
- DEVICE_AVAILABILITY
- DEVICE_AVAILABILITY_SUMMARY
- DEVICE_CPU_UTILIZATION_TREND
- DEVICE_MEMORY_UTILIZATION_TREND
- DEVICE_HEALTH_INFO
- DEVICE_REACHABILITY_STATUS
- DEVICE_PORT_SUMMARY
- DEVICE_AVAILABILITY_MESSAGE
- DEVICE_DOWN_MESSAGE
- DEVICE_CPU_UTILIZATION_SUMMARY
- INTERFACE_AVAILABILITY
- INTERFACE_DETAILS
- INTERFACE_OUT_ERRORS
- INTERFACE_DISCARDS
- INTERFACE_UTILIZATION
- INTERFACE_TOPN_UTILIZATION
- INTERFACE_TOPN_ERRORS
- INTERFACE_TOPN_WAN_UTILIZATION
- INTERFACE_UTILIZATION_SUMMARY
- INTERFACE_AVAILABILITY_SUMMARY
- INTERFACE_STATUS_SUMMARY
- INTERFACE_AVAILABILITY_MESSAGE
- INTERFACE_DOWN_MESSAGE
- INTERFACE_TOPN_WAN_ISSUES
- INTERFACE_CLASSMAP_QOS
- APPLICATION_TOPN_WORST_HOSTS
- APPLICATION_TOPN_WORST_SITES
- APPLICATION_TOPN_HOSTS
- APPLICATION_TOPN_APP_PERFORMANCE
- APPLICATION_TOPN_TRAFFIC_ANALYSIS
- APPLICATION_NUMBER_OF_USERS
- SYSTEM_INFO
- SYSTEM_HEALTH
- APPLICATION_VOLUME
- APPLICATION_ART_ANALYSIS
- APPLICATION_TOPN_TRAFFICS
- APPLICATION_TOPN_WITH_SITES
|
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
Allowed values:
- DEVICE_TOPN_CPU_UTILIZATION
- DEVICE_TOPN_MEMORY_UTILIZATION
- DEVICE_TOPN_TEMPERATURE
- DEVICE_AVAILABILITY
- DEVICE_AVAILABILITY_SUMMARY
- DEVICE_CPU_UTILIZATION_TREND
- DEVICE_MEMORY_UTILIZATION_TREND
- DEVICE_HEALTH_INFO
- DEVICE_REACHABILITY_STATUS
- DEVICE_PORT_SUMMARY
- DEVICE_AVAILABILITY_MESSAGE
- DEVICE_DOWN_MESSAGE
- DEVICE_CPU_UTILIZATION_SUMMARY
- INTERFACE_AVAILABILITY
- INTERFACE_DETAILS
- INTERFACE_OUT_ERRORS
- INTERFACE_DISCARDS
- INTERFACE_UTILIZATION
- INTERFACE_TOPN_UTILIZATION
- INTERFACE_TOPN_ERRORS
- INTERFACE_TOPN_WAN_UTILIZATION
- INTERFACE_UTILIZATION_SUMMARY
- INTERFACE_AVAILABILITY_SUMMARY
- INTERFACE_STATUS_SUMMARY
- INTERFACE_AVAILABILITY_MESSAGE
- INTERFACE_DOWN_MESSAGE
- INTERFACE_TOPN_WAN_ISSUES
- INTERFACE_CLASSMAP_QOS
- APPLICATION_TOPN_WORST_HOSTS
- APPLICATION_TOPN_WORST_SITES
- APPLICATION_TOPN_HOSTS
- APPLICATION_TOPN_APP_PERFORMANCE
- APPLICATION_TOPN_TRAFFIC_ANALYSIS
- APPLICATION_NUMBER_OF_USERS
- SYSTEM_INFO
- SYSTEM_HEALTH
- APPLICATION_VOLUME
- APPLICATION_ART_ANALYSIS
- APPLICATION_TOPN_TRAFFICS
- APPLICATION_TOPN_WITH_SITES
|
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://localhost/webacs/api/v4/op/statisticsService/application/topNHosts?range=1&topN=5
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/statisticsService/application/topNHosts?range=1&amp;topN=5" rootUrl="https://localhost/webacs/api/v4/op">
<statisticsDTO>
<childStatistics></childStatistics>
<statisticEntries>
<statisticEntry>
<attributeName>String value</attributeName>
<displayName>String value</displayName>
<entryValue>String value</entryValue>
</statisticEntry>
<statisticEntry>
<attributeName>Another string value</attributeName>
<displayName>Another string value</displayName>
<entryValue>Another string value</entryValue>
</statisticEntry>
</statisticEntries>
<statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
</statisticsDTO>
<statisticsDTO>
<childStatistics></childStatistics>
<statisticEntries>
<statisticEntry>
<attributeName>String value</attributeName>
<displayName>String value</displayName>
<entryValue>String value</entryValue>
</statisticEntry>
<statisticEntry>
<attributeName>Another string value</attributeName>
<displayName>Another string value</displayName>
<entryValue>Another string value</entryValue>
</statisticEntry>
</statisticEntries>
<statisticsName>DEVICE_TOPN_MEMORY_UTILIZATION</statisticsName>
</statisticsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v4/op/statisticsService/application/topNHosts.json?range=1&topN=5
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/statisticsService/application/topNHosts?range=1&topN=5",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v4/op",
"statisticsDTO" : [ {
"childStatistics" : {
"childStatistic" : [ ]
},
"statisticEntries" : {
"statisticEntry" : [ {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
}, {
"attributeName" : "Another string value",
"displayName" : "Another string value",
"entryValue" : "Another string value"
} ]
},
"statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
}, {
"childStatistics" : {
"childStatistic" : [ ]
},
"statisticEntries" : {
"statisticEntry" : [ {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
}, {
"attributeName" : "Another string value",
"displayName" : "Another string value",
"entryValue" : "Another string value"
} ]
},
"statisticsName" : "DEVICE_TOPN_MEMORY_UTILIZATION"
} ]
}
}