Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

POST pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/{startTime}/{endTime}/{topN}

Provides a snapshot view of how Service Providers are being utilized to carry traffic for various DSCPs. This call is over HTTP(s) POST where a filter object having one or more or none of the below filters 1) Source Site 2) Destination Site 3) DSCP 4) Service Provider 5) TCA Metrics. The URL format is:/op/pfrMonitoringExt/getMaxJitterVsDSCPChartReportsViaPost/startTime/endTime. Here are the sample queries:
  • /op/pfrMonitoringExt/getMaxJitterVsDSCPChartReportsViaPost/1475824562/1476429362 + PostBody -- Returns a snapshot view of how Service Providers are being utilized to carry traffic for various DSCPs

Sample PostBody:

{ "pfRLandingPageFilterDTO" : { "dSCPs" : { "dSCPs" :"5" } } }

Since Product Version: 3.1

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Write

HTTP Methods

POST

DevNet Discussions

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

Resource URL

/webacs/api/v1/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/{startTime}/{endTime}/{topN}

Request Parameters

Attribute Source Description

startTime Long

path

RequiredstartTime in milliseconds

endTime Long

path

RequiredendTime in milliseconds

topN Integer

path

RequiredtopN

Request Payload Parameters

Attribute Description

dSCPs String[]

dscpList

fromLGs String[]

lGRole String

locationGroupRole

lGs String[]

locationGroupList

pfREventMetricListDTO PfREventMetricListDTO[]

pfREvents String[]

pfrEventList

serviceProviders String[]

List of Service Provider

toLGs String[]

toLGList

vrfs String

pfrVRFId

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
  • 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 Request Payload

https://localhost/webacs/api/v1/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/1465200910/1465204510/5

<?xml version="1.0" ?>
<pfRLandingPageFilterDTO>
  <dSCPs>
    <dSCPs>String value</dSCPs>
  </dSCPs>
  <fromLGs>
    <fromLGs>String value</fromLGs>
  </fromLGs>
  <LGRole>String value</LGRole>
  <lGsList>
    <lGs>String value</lGs>
  </lGsList>
  <pfREventMetricListDTOList>
    <pfREventMetricListDTO>
      <anyAllCondition>String value</anyAllCondition>
      <eventName>String value</eventName>
      <metricListDTOList>
        <metricListDTO>
          <leftOperand>String value</leftOperand>
          <operator>String value</operator>
          <rightOperand>String value</rightOperand>
        </metricListDTO>
      </metricListDTOList>
    </pfREventMetricListDTO>
  </pfREventMetricListDTOList>
  <pfREventsList>
    <pfREvents>String value</pfREvents>
  </pfREventsList>
  <serviceProvidersList>
    <serviceProviders>String value</serviceProviders>
  </serviceProvidersList>
  <toLGs>
    <toLGs>String value</toLGs>
  </toLGs>
  <vrfs>String value</vrfs>
</pfRLandingPageFilterDTO>

Sample JSON Request Payload

https://localhost/webacs/api/v1/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/1465200910/1465204510/5.json

{
  "pfRLandingPageFilterDTO" : {
    "dSCPs" : {
      "dSCPs" : "String value"
    },
    "fromLGs" : {
      "fromLGs" : "String value"
    },
    "LGRole" : "String value",
    "lGsList" : {
      "lGs" : "String value"
    },
    "pfREventMetricListDTOList" : {
      "pfREventMetricListDTO" : {
        "anyAllCondition" : "String value",
        "eventName" : "String value",
        "metricListDTOList" : {
          "metricListDTO" : {
            "leftOperand" : "String value",
            "operator" : "String value",
            "rightOperand" : "String value"
          }
        }
      }
    },
    "pfREventsList" : {
      "pfREvents" : "String value"
    },
    "serviceProvidersList" : {
      "serviceProviders" : "String value"
    },
    "toLGs" : {
      "toLGs" : "String value"
    },
    "vrfs" : "String value"
  }
}

Sample XML Response Payload

https://localhost/webacs/api/v1/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/1465200910/1465204510/5

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

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/pfrMonitoringExt\/getServiceProviderUsageVsDSCPChart\/1465200910\/1465204510\/5",
    "@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
    "statisticsDTO" : {
      "childStatistics" : "",
      "statisticEntries" : {
        "statisticEntry" : {
          "attributeName" : "String value",
          "displayName" : "String value",
          "entryValue" : "String value"
        }
      },
      "statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
    }
  }
}