Cisco Cisco Prime Performance Manager 1.7 Guida Dello Sviluppatore

Pagina di 44
 
Cisco Prime Performance Manager 1.7 REST API Guide 
2.2 HTTP Version 
The Reports REST API embraces several aspects of the HTTP standards, including some HTTP headers, 
verbs, and status codes. The REST API uses status codes that are only supported in the HTTP/1.1 version. 
Therefore, it is expected that the client consuming this API complies with these HTTP/1.1 features. 
2.3 SSL and HTTP 
This API is served over an HTTPs secure connection when the Prime Performance Manager server has 
SSL installed and enabled. In this case the client side must support the HTTP/SSL protocol and have the 
Prime Performance Manager SSL public certificate installed on the client’s thrust store file. 
2.4 Read Only API 
This REST API is used for reading network performance reporting data. It supports the HTTP GET 
method which does not affect the state of the resource being queried in the server. 
2.5 Versioning 
The Prime Performance Manager Reports REST API complies with the following versioning rule: 
elements can be added when releasing a new version, but they may never be removed. A new release of 
this API is expected to be downward compatible with a previous version. An older version of this Reports 
REST API might appear to the client as if some elements were removed. 
3  Prime Performance Manager REST API 
Installation 
This document does not tell you how to install or configure the Prime Performance Manager. See the 
Cisco Prime Performance Manager 1.7 User Guide and Cisco Prime Performance Manager 1.7 Quick 
Start Guide
 for installation and configuration procedures. Also, the steps to configure SSL and 
authentication are not provided, as that pertains to the Prime Performance Manager server.  
The Reports REST API is a Prime Performance Manager gateway component. All code needed to run and 
test the Reports REST API is included in the Prime Performance Manager installation. After you install 
the Prime Performance Manager, no additional Prime Performance Manager Reports REST API 
configuration is needed. 
4  Reports Default Time Durations 
The reporting data returned from the REST API defaults to the following durations, based off the interval 
intervalTypeKey parameter. If the startDate and endDate parameters are provided in the URL 
(refer to Query String Parameters), the duration is constrained by the time difference between the 
endDate and startDate. 
Note: when the intervalTypeKey or startDate/endDate date parameters are not provided in the 
URL, the interval/duration defaults to “15 min / Last 12 hours” for node or group level reports, and 
“Hourly / Last 24 hours” for network level reports.