Cisco Cisco Prime Performance Manager 1.5 Guide Du Développeur

Page de 41
 
Cisco Prime Performance Manager1.5 REST API Guide 
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.5 User Guide and Cisco Prime Performance Manager 1.5 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. 
Table 1 - Report Default Durations 
Interval 
intervalTypeKey (parameter) 
Duration  
15 sec 
FIFTEEN_SECS 
Last 1 hour 
30 sec 
THIRTY_SECS 
Last 1 hour 
1 min 
ONE_MINUTE 
Last 1 hour 
5 min 
FIVE_MINUTE 
Last 6 hours 
15 min
1
 
QUARTER_HOUR 
Last 12 hours 
Hourly 
2
 
HOUR 
Last 24 hours 
Daily 
DAY 
Last 30 days 
Weekly 
WEEK 
Last 6 months 
                                                                 
1
 Node or Group reports are by default rendered as 15 min interval reports. A node report requires either an FQDN 
Node or sgmid value to be provided in the FQDN or sgmid parameters in the REST API URL.  A group report 
uses its own URL path “/groupreports” and the corresponding Group name defined in the FQDN parameter. 
2
 Network level reports are by default rendered as hourly reports. Network level reports consist of data for the top 
node elements.  Network level is the default report type when no FQDN=Node or sgmid query string parameter is 
provided in the REST API URL.