Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET pfrMonitoringExt/getDscpAppUsage/{startTime}/{endTime}

Fetches WAN Link bandwidth usage in terms of data volume w.r.t DSCP and applications classified for that DSCP, withinin a specified time range for a site pair. This API accepts the Site names and Site hierarchies.The URL format is:/op/pfrMonitoringExt/getDscpAppUsage/startTime/endTime?srcSiteName&dstSiteName&managedIpBR&tunnelName&srcHierarchyPath&destHierarchyPath. Here are the sample queries:
  • /op/pfrMonitoringExt/getDscpAppUsage/1475824562/1476429362 --Returns WAN Link bandwidth usage in terms of data volume within the given startTime and endTime
  • /op/pfrMonitoringExt/getDscpAppUsage/1475824562/1476429362?srcSiteName=BANGALORE&dstSiteName=SAN JOSE&managedIpBR=10.1.1.1&tunnelName=tunnel1&srcHierarchyPath=Location/All Locations&destHierarchyPath=Location/All Locations/INDIA --Returns WAN Link bandwidth usage in terms of data volume for the given site pair under srcHierarchyPath and destHierarchyPath within 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/v3/op/pfrMonitoringExt/getDscpAppUsage/{startTime}/{endTime}

Unmodified

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

Request Parameters

Attribute Source Description

startTime Long

path

RequiredSpecifies the start time in milli seconds to get the DSCP app usage from.

endTime Long

path

RequiredSpecifies the start time in milli seconds to get the DSCP app usage to.

srcSiteName String

query

OptionalOPTIONAL Specifies the source site to get the DSCP app usage.

dstSiteName String

query

OptionalOPTIONAL Specifies the destination site to get the DSCP app usage.

managedIpBR String

query

OptionalOPTIONAL Specifies the managed ip to get the DSCP app usage.

tunnelName String

query

OptionalOPTIONAL Specifies the tunnel name to get the DSCP app usage.

srcHierarchyPath String

query

OptionalOPTIONAL Specifies the source site hierarchy to get the DSCP app usage.

destHierarchyPath String

query

OptionalOPTIONAL Specifies the destination site hierarchy to get the DSCP app usage.

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.

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/pfrMonitoringExt/getDscpAppUsage/1463999256/1465208856?srcSiteName="Site1"&dstSiteName="Site2"&managedIpBR="192.168.3.0"&tunnelName="tunnelName"&srcHierarchyPath="Location/All Locations/Site1&destHierarchyPath="Location/All Locations/Site1"

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/pfrMonitoringExt/getDscpAppUsage/1463999256/1465208856?srcSiteName=&amp;quot;Site1&amp;quot;&amp;amp;dstSiteName=&amp;quot;Site2&amp;quot;&amp;amp;managedIpBR=&amp;quot;192.168.3.0&amp;quot;&amp;amp;tunnelName=&amp;quot;tunnelName&amp;quot;&amp;amp;srcHierarchyPath=&amp;quot;Location/All
						Locations/Site1&amp;amp;destHierarchyPath=&amp;quot;Location/All Locations/Site1&amp;quot;
					" 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/pfrMonitoringExt/getDscpAppUsage/1463999256/1465208856.json?srcSiteName="Site1"&dstSiteName="Site2"&managedIpBR="192.168.3.0"&tunnelName="tunnelName"&srcHierarchyPath="Location/All Locations/Site1&destHierarchyPath="Location/All Locations/Site1"

{
  "mgmtResponse" : {
    "@requestUrl" : "https://localhost/webacs/api/v3/op/pfrMonitoringExt/getDscpAppUsage/1463999256/1465208856?srcSiteName=&quot;Site1&quot;&amp;dstSiteName=&quot;Site2&quot;&amp;managedIpBR=&quot;192.168.3.0&quot;&amp;tunnelName=&quot;tunnelName&quot;&amp;srcHierarchyPath=&quot;Location/All\n\t\t\t\t\t\tLocations/Site1&amp;destHierarchyPath=&quot;Location/All Locations/Site1&quot;\n\t\t\t\t\t",
    "@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"
    } ]
  }
}