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

GET pfrMonitoringExt/getWanUtilizationOverTimeForLink/{startTime}/{endTime}/{brIpAddr}/{direction}

Fetches WAN Link utilization trend over time from PfR Bandwidth NetFlow from a Border Router for either IN or OUT direction. The URL format is:/op/pfrMonitoringExt/getWanUtilizationOverTimeForLink/startTime/endTime/deviceIp/rownum?interfaceName. Here are the sample queries:
  • /op/pfrMonitoringExt/getWanUtilizationOverTimeForLink/1475824562/1476429362/10.1.1.1/5?interfaceName=GigabitEthernet0 -- Returns the WAN Link utilization trend over time from PfR Bandwidth NetFlow from a given Border Router,inerface within the startTime and endTime

Since Product Version: 3.1

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/pfrMonitoringExt/getWanUtilizationOverTimeForLink/{startTime}/{endTime}/{brIpAddr}/{direction}

Unmodified

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

Request Parameters

Attribute Source Description

startTime Long

path

Required

startTime in milliseconds

endTime Long

path

Required

endTime in milliseconds

brIpAddr String

path

Required

brIpAddr

direction String

path

Required

direction

interfaceName String

query

Required

interfaceName

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://172.20.127.108/webacs/api/v4/op/pfrMonitoringExt/getWanUtilizationOverTimeForLink/1465200910/1465204510/10.11.12.13/5

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.20.127.108/webacs/api/v4/op/pfrMonitoringExt/getWanUtilizationOverTimeForLink/1465200910/1465204510/10.11.12.13/5" rootUrl="https://172.20.127.108/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://172.20.127.108/webacs/api/v4/op/pfrMonitoringExt/getWanUtilizationOverTimeForLink/1465200910/1465204510/10.11.12.13/5.json

{
  "mgmtResponse" : {
    "@requestUrl" : "https://172.20.127.108/webacs/api/v4/op/pfrMonitoringExt/getWanUtilizationOverTimeForLink/1465200910/1465204510/10.11.12.13/5",
    "@responseType" : "operation",
    "@rootUrl" : "https://172.20.127.108/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"
    } ]
  }
}