Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

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

Fetches all Route Change events reported from the Master Controller of the source site for a Site-to-Site communication. A Route Change event typically indicates that for a given class of traffic, PfR feature (running on Cisco devices) is able to automatically circumvent Network issues by re-routing traffic.The URL format is:/op/pfrMonitoringExt/getAllRCs/srcSite/dstSite/startTime/endTime?srcHierarchyPath&destHierarchyPath. Here are the sample queries:
  • /op/pfrMonitoringExt/getAllRCs/BANGALORE/SAN JOSE/1475824562/1476429362-- Returns Route Change events reported from the Master Controller of the source site for a given Site-to-Site communication within a specified time range.
  • /op/pfrMonitoringExt/getAllRCs/BANGALORE/SAN JOSE/1475824562/1476429362?srcHierarchyPath=/Location/All locations-- Returns Route Change events 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/getAllRCs/BANGALORE/SAN JOSE/1475824562/1476429362?srcHierarchyPath=/Location/All locations&destHierarchyPath=/Location/All locations/INDIA-- Returns Route Change events 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 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

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/getAllRCs/{srcSite}/{dstSite}/{startTime}/{endTime}

Request Parameters

Attribute Source Description

startTime Long

path

RequiredSpecifies the start time in milli seconds to get the all RCs from.

endTime Long

path

RequiredSpecifies the start time in milli seconds to get the all RCs to

srcSite String

path

RequiredSpecifies the source site to get the all RCs .

dstSite String

path

RequiredSpecifies the destination site to get the all RCs.

srcHierarchyPath String

query

OptionalOPTIONAL Specifies the source site hierarchy to get the all RCs .

destHierarchyPath String

query

OptionalOPTIONAL Specifies the destination site hierarchy to get the all RCs .

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/v1/op/pfrMonitoringExt/getAllRCs/Site1/Site2/1463999256234/1465208856123?srcHierarchyPath="Location/All Locations/Site1&destHierarchyPath="Location/All Locations/Site1"

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/pfrMonitoringExt/getAllRCs/Site1/Site2/1463999256234/1465208856123?srcHierarchyPath=&amp;quot;Location/All Locations/Site1&amp;amp;destHierarchyPath=&amp;quot;Location/All
						Locations/Site1&amp;quot;
					" 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/getAllRCs/Site1/Site2/1463999256234/1465208856123.json?srcHierarchyPath="Location/All Locations/Site1&destHierarchyPath="Location/All Locations/Site1"

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