Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

GET statisticsService/device/cpuUtilSummary

Gets the device CPU Utilization Summary Statistics.

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/v4/op/statisticsService/device/cpuUtilSummary

Unmodified

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

Request Parameters

Attribute Source Description

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.

startTime Long

query

Required

Represents the start time of a time period in seconds. (See 'range' for more details)

endTime Long

query

Required

Represents the end time of a time period in seconds. (See 'range' for more details)

type String

query

Optional

An optional filter that specifies the response data format. Possible values: TABLE, PIECHART. By default, when not specified the response has pie chart type data.

source String

query

Optional

An optional filter parameter that can be used to provide the IP Address or a group ID to get a filtered response.

rangeString String

query

Optional

Specifies the pie chart range list. The responses use the provided ranges in the same order. An example format which is the default when not specified: 0-25,76-100,51-75,26-50.

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://10.64.80.159/webacs/api/v4/op/statisticsService/device/cpuUtilSummary?range=1

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.64.80.159/webacs/api/v4/op/statisticsService/device/cpuUtilSummary?range=1" rootUrl="https://10.64.80.159/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>
</mgmtResponse>

Sample JSON Response Payload

https://10.64.80.159/webacs/api/v4/op/statisticsService/device/cpuUtilSummary.json?range=1

{
  "mgmtResponse" : {
    "@requestUrl" : "https://10.64.80.159/webacs/api/v4/op/statisticsService/device/cpuUtilSummary?range=1",
    "@responseType" : "operation",
    "@rootUrl" : "https://10.64.80.159/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"
    } ]
  }
}