Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET pfrMonitoringExt/getDscpAppUsageForLiveTopo/{startTime}/{endTime}/{srcSiteId}/{dstSiteId}

Fetches WAN Link bandwidth usage in terms of data volume w.r.t DSCP and applications classified for that DSCP, within a specified time range for a site pair and a VRF. This API accepts Site Ids in Prime and VRF Ids assigned by Prime PfR NetFlow processing. The pre-requisite of using this API is to fetch the Site Ids and VRF Ids stored in Prime and then use those Ids in this API. The URL format is:/op/pfrMonitoringExt/getDscpAppUsageForLiveTopo/startTime/endTime/srcSiteId/dstSiteId?vrfIdList. Here are the sample queries:
  • /op/pfrMonitoringExt/getDscpAppUsageForLiveTopo/1475824562/1476429362/84116/6439435 -- Returns the WAN Link bandwidth usage for the given source site id, destination site id and within the startTime and endTime
  • /op/pfrMonitoringExt/getDscpAppUsageForLiveTopo/1475824562/1476429362/84116/6439435?vrfIdList=vrfidlist -- Returns the WAN Link bandwidth usage for the given source site id, destination site id, vrf id and within the startTime and endTime

Since Product Version: 3.1

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

DevNet Discussions

Resource URL

/webacs/api/v2/op/pfrMonitoringExt/getDscpAppUsageForLiveTopo/{startTime}/{endTime}/{srcSiteId}/{dstSiteId}

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 getDscpAppUsageForLiveTopo from.

endTime Long

path

RequiredSpecifies the start time in milli seconds to get the getDscpAppUsageForLiveTopo to.

srcSiteId Long

path

RequiredSpecifies the source id to get the getDscpAppUsageForLiveTopo .

dstSiteId Long

path

RequiredSpecifies the destination id to get the getDscpAppUsageForLiveTopo .

vrfIdList String

query

OptionalOPTIONAL Specifies the Vrf id list to get the getDscpAppUsageForLiveTopo .

Response Parameters

Attribute Description

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.

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

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/pfrMonitoringExt/getDscpAppUsageForLiveTopo/1463999256/1465208856/84011/84083?vrfIdList="vrfidlist"

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/pfrMonitoringExt/getDscpAppUsageForLiveTopo/1463999256/1465208856/84011/84083?vrfIdList=&amp;quot;vrfidlist&amp;quot;
					" rootUrl="https://localhost/webacs/api/v2/op">
  <statisticsDTO>
    <childStatistics>
      <childStatistic>
        <childStatistics>
          <childStatistic>
            <childStatistics>
              <childStatistic>
                <childStatistics>
                  <childStatistic>
                    <statisticEntries>
                      <statisticEntry>
                        <attributeName>String value</attributeName>
                        <displayName>String value</displayName>
                        <entryValue>String value</entryValue>
                      </statisticEntry>
                    </statisticEntries>
                    <statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
                  </childStatistic>
                </childStatistics>
                <statisticEntries>
                  <statisticEntry>
                    <attributeName>String value</attributeName>
                    <displayName>String value</displayName>
                    <entryValue>String value</entryValue>
                  </statisticEntry>
                </statisticEntries>
                <statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
              </childStatistic>
            </childStatistics>
            <statisticEntries>
              <statisticEntry>
                <attributeName>String value</attributeName>
                <displayName>String value</displayName>
                <entryValue>String value</entryValue>
              </statisticEntry>
            </statisticEntries>
            <statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
          </childStatistic>
        </childStatistics>
        <statisticEntries>
          <statisticEntry>
            <attributeName>String value</attributeName>
            <displayName>String value</displayName>
            <entryValue>String value</entryValue>
          </statisticEntry>
        </statisticEntries>
        <statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
      </childStatistic>
    </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/pfrMonitoringExt/getDscpAppUsageForLiveTopo/1463999256/1465208856/84011/84083.json?vrfIdList="vrfidlist"

{
  "mgmtResponse" : {
    "@requestUrl" : "https://localhost/webacs/api/v2/op/pfrMonitoringExt/getDscpAppUsageForLiveTopo/1463999256/1465208856/84011/84083?vrfIdList=&quot;vrfidlist&quot;\n\t\t\t\t\t",
    "@responseType" : "operation",
    "@rootUrl" : "https://localhost/webacs/api/v2/op",
    "statisticsDTO" : [ {
      "childStatistics" : {
        "childStatistic" : [ {
          "childStatistics" : {
            "childStatistic" : [ {
              "childStatistics" : {
                "childStatistic" : [ {
                  "childStatistics" : {
                    "childStatistic" : [ {
                      "statisticEntries" : {
                        "statisticEntry" : [ {
                          "attributeName" : "String value",
                          "displayName" : "String value",
                          "entryValue" : "String value"
                        } ]
                      },
                      "statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
                    } ]
                  },
                  "statisticEntries" : {
                    "statisticEntry" : [ {
                      "attributeName" : "String value",
                      "displayName" : "String value",
                      "entryValue" : "String value"
                    } ]
                  },
                  "statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
                } ]
              },
              "statisticEntries" : {
                "statisticEntry" : [ {
                  "attributeName" : "String value",
                  "displayName" : "String value",
                  "entryValue" : "String value"
                } ]
              },
              "statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
            } ]
          },
          "statisticEntries" : {
            "statisticEntry" : [ {
              "attributeName" : "String value",
              "displayName" : "String value",
              "entryValue" : "String value"
            } ]
          },
          "statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
        } ]
      },
      "statisticEntries" : {
        "statisticEntry" : [ {
          "attributeName" : "String value",
          "displayName" : "String value",
          "entryValue" : "String value"
        } ]
      },
      "statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
    } ]
  }
}