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

GET pfrMonitoringExt/getAllTCAs/{srcSite}/{dstSite}/{startTime}/{endTime}

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Fetches all Threshold Crossing Alerts reported from the Master Controller of the source site for a Site-to-Site communication within a specified time range. A Threshold Crossing Alert typically indicates that for a given class of traffic, PfR feature (running on Cisco devices) has identified network issues that are imparing the traffic quality (measured in terms of Jitter, Delay, Packet Loss). The URL format is:/op/pfrMonitoringExt/getAllRCs/srcSite/dstSite/startTime/endTimes?rcHierarchyPath&destHierarchyPath. Here are the sample queries:
  • /op/pfrMonitoringExt/getAllTCAs/BANGALORE/SAN JOSE/1475824562/1476429362-- Returns all Threshold Crossing Alerts reported from the Master Controller of the source site for a given Site-to-Site communication within a specified time range.
  • /op/pfrMonitoringExt/getAllTCAs/BANGALORE/SAN JOSE/1475824562/1476429362?srcHierarchyPath=/Location/All locations-- Returns all Threshold Crossing Alerts reported from the Master Controller of the source site for a given Site-to-Site communication under srcHierarchyPath within a specified time range.
  • /op/pfrMonitoringExt/getAllTCAs/BANGALORE/SAN JOSE/1475824562/1476429362?srcHierarchyPath=/Location/All locations&destHierarchyPath=/Location/All locations/INDIA-- Returns all Threshold Crossing Alerts reported from the Master Controller of the source site for a given Site-to-Site communication under srcHierarchyPath and destHierarchyPath within a specified time range.

Since Product Version: 3.1

Resource URL

/webacs/api/v1/op/pfrMonitoringExt/getAllTCAs/{srcSite}/{dstSite}/{startTime}/{endTime}

Request Parameters

Type Attribute Name Source Description

Long

startTime required

path

Specifies the start time in milli seconds to get the all TCAs from.

Long

endTime required

path

Specifies the start time in milli seconds to get the all TCAs to.

String

srcSite required

path

Specifies the source site to get the all TCAs .

String

dstSite required

path

Specifies the destination site to get the all TCAs .

String

destHierarchyPath optional

query

OPTIONAL Specifies the destination site hierarchy to get the all TCAs .

String

srcHierarchyPath optional

query

OPTIONAL Specifies the source site hierarchy to get the all TCAs .

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

https://172.25.123.114/webacs/api/v1/op/pfrMonitoringExt/getAllTCAs/Site1/Site2/1463999256234/1465208856123?srcHierarchyPath="Location/All Locations/Site1&destHierarchyPath="Location/All Locations/Site1"

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v1/op/pfrMonitoringExt/getAllTCAs/Site1/Site2/1463999256234/1465208856123?srcHierarchyPath=&amp;quot;Location/All Locations/Site1&amp;amp;destHierarchyPath=&amp;quot;Location/All Locations/Site1&amp;quot;
					" rootUrl="https://172.25.123.114/webacs/api/v1/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>
    <statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
  </statisticsDTO>
</mgmtResponse>

Sample JSON Response Payload

https://172.25.123.114/webacs/api/v1/op/pfrMonitoringExt/getAllTCAs/Site1/Site2/1463999256234/1465208856123.json?srcHierarchyPath="Location/All Locations/Site1&destHierarchyPath="Location/All Locations/Site1"

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/pfrMonitoringExt\/getAllTCAs\/Site1\/Site2\/1463999256234\/1465208856123?srcHierarchyPath=&quot;Location\/All Locations\/Site1&amp;destHierarchyPath=&quot;Location\/All Locations\/Site1&quot;\n\t\t\t\t\t",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/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"
        }
      },
      "statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
    }
  }
}