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

POST pfrMonitoringExt/getDSCPvsUrTCAViaPost/{startTime}/{endTime}

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Response Formats

xml

json

User Group

NBI Write

HTTP Methods

POST

Fetches UnReachable events experienced by various DSCPs in a PfR controlled network. This call is over HTTP(s)POST where a filter object having one or more or none of the below filters can be applied 1) Source Site 2) Destination Site 3) DSCP 4) Service Provider 5) TCA Metrics The URL format is:/op/pfrMonitoringExt/getDSCPvsUrTCAViaPost/startTime/endTime. Here are the sample queries:
  • /op/pfrMonitoringExt/getDSCPvsUrTCAViaPost/1475824562/1476429362 + PostBody -- Returns UnReachable events experienced by various DSCPs in a PfR controlled network

Sample PostBody:

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

Since Product Version: 3.1

Resource URL

/webacs/api/v1/op/pfrMonitoringExt/getDSCPvsUrTCAViaPost/{startTime}/{endTime}

Request Parameters

Type Attribute Name Source Description

Long

startTime required

path

startTime in milliseconds

Long

endTime required

path

endTime in milliseconds

Request Payload Parameters

Type Attribute Name Description

String[]

dSCPs

dscpList

String[]

fromLGs

String

lGRole

locationGroupRole

String[]

lGs

locationGroupList

PfREventMetricListDTO[]

pfREventMetricListDTO

String[]

pfREvents

pfrEventList

String[]

serviceProviders

List of Service Provider

String[]

toLGs

toLGList

String

vrfs

pfrVRFId

Response Parameters

Type Attribute Name Description

StatisticsDTO[]

childStatistics

The set of nested StatisticsDTO objects.

StatisticsEntry[]

statisticEntry

The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.

StatisticsOperationTypeEnum

statisticsName

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

https://172.25.123.114/webacs/api/v1/op/pfrMonitoringExt/getDSCPvsUrTCAViaPost/1465200910/1465204510

<?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://172.25.123.114/webacs/api/v1/op/pfrMonitoringExt/getDSCPvsUrTCAViaPost/1465200910/1465204510.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://172.25.123.114/webacs/api/v1/op/pfrMonitoringExt/getDSCPvsUrTCAViaPost/1465200910/1465204510

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v1/op/pfrMonitoringExt/getDSCPvsUrTCAViaPost/1465200910/1465204510" rootUrl="https://172.25.123.114/webacs/api/v1/op/">
  <statisticsDTO>
    <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>
  </statisticsDTO>
</mgmtResponse>

Sample JSON Response Payload

https://172.25.123.114/webacs/api/v1/op/pfrMonitoringExt/getDSCPvsUrTCAViaPost/1465200910/1465204510.json

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/pfrMonitoringExt\/getDSCPvsUrTCAViaPost\/1465200910\/1465204510",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/",
    "statisticsDTO" : {
      "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"
    }
  }
}