Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET statisticsService/application/topNHosts

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

xml

json

User Group

NBI Read

HTTP Methods

GET

Resource URL

/webacs/api/v2/op/statisticsService/application/topNHosts

Unmodified

This resource has not been modified since the previous API version.

Request Parameters

Attribute Source Description

startTime Long

query

Required

Specifies the time to check the top N hosts from. (See 'range' for more details)

endTime Long

query

Required

Specifies the time to check the top N hosts to. (See 'range' for more details)

range Integer

query

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.

appId String

query

Optional

Use to filter on a specific application by ID. If not specified then statistics for all applications will be returned.

siteId Integer

query

Optional

Use to filter on a specific site by ID. If not specified then statistics for all sites will be returned.

domainId String

query

Optional

Use to filter on a specific domain by ID. Only used with siteId is zero. Defaults to ROOT-DOMAIN.

pdsId String

query

Optional

Use to filter on a specific data source by ID. If not specified then statistics for all data sources will be returned.

topN Integer

query

Required

The number of results to return.

trafficDir String

query

Optional

The direction of traffic to measure (All, In, Out). Defaults to All.

ipAddress String

query

Optional

A specific ipAddress of a device. Required when pdsId=0 and interfaceName!=null.

interfaceName String

query

Optional

An interface name on the device given by ipAddress field.

interfaceId Integer

query

Optional

A specific index of an interface . Required when pdsId=0 and interfaceName!=null.

sortOrder String

query

Optional

The sort order of the results (ASC/DESC). Defaults to DESC.

nwAwareValue String

query

Optional

Use to filter on a specific connection type. If not specified then statistics for all connection types will be returned.

ssidValue String

query

Optional

Use to filter on a specific SSID. If not specified then statistics for all SSID will be returned.

Response Parameters

Attribute Description

childStatistics Arrow image StatisticsDTO[]

The set of nested StatisticsDTO objects.

statisticEntry Arrow image 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.

statisticsName StatisticsOperationTypeEnum

The Statistics operation type.

  • 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;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&amp;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"
    } ]
  }
}