Cisco Cisco Prime Performance Manager 1.5 Developer's Guide
Cisco Prime Performance Manager1.5 REST API Guide
For example, if a query string parameter value should contain the positive sign (+), URL encode the “+”
character to its corresponding URL escaped sequence “%2B”; otherwise, the “+” will be interpreted as a
space by the REST API. Other characters such as “{“, “}”, “|”, “\”, “^”, “~”, “[“, “]”, and “`” are unsafe
because gateways and other transport agents are known to sometimes modify these characters.
character to its corresponding URL escaped sequence “%2B”; otherwise, the “+” will be interpreted as a
space by the REST API. Other characters such as “{“, “}”, “|”, “\”, “^”, “~”, “[“, “]”, and “`” are unsafe
because gateways and other transport agents are known to sometimes modify these characters.
When in doubt about the safety of a character within a query string parameter value, encode the query
string parameter value before submitting a request.
string parameter value before submitting a request.
The server side of the REST API always decodes the passed in query string parameter values according to
RFC 3986 standards. Therefore, the client side can safely encode the parameter values using the same
standards.
RFC 3986 standards. Therefore, the client side can safely encode the parameter values using the same
standards.
Note: The “+” (plus-sign) represents a space in the URL. If you want to pass a positive sign plus (+)
character as part of a parameter value (for example, 2006-08-25T15:30+0800), encode the “+” to its
respective URL encoded form “%2B”.
character as part of a parameter value (for example, 2006-08-25T15:30+0800), encode the “+” to its
respective URL encoded form “%2B”.
5.7 Query String Parameters
The following tables show the REST API request query string parameters. The REST API uses a subset
of the HTTP request parameters found in the Prime Performance Manager web application. The
parameter names found in the Prime Performance Manager web application are also found in the REST
API. This allows the REST API and Prime Performance Manager web application to have consistent
naming andalso allows the same values used in the Prime Performance Manager web application to be
passed to the REST API.
of the HTTP request parameters found in the Prime Performance Manager web application. The
parameter names found in the Prime Performance Manager web application are also found in the REST
API. This allows the REST API and Prime Performance Manager web application to have consistent
naming andalso allows the same values used in the Prime Performance Manager web application to be
passed to the REST API.
Notes:
Parameter names/values are case-sensitive.
Parameter values should be encoded to escape unsafe HTTP characters.
Some parameters are mutually exclusive.
5.7.1 FQDN
Table 7 – FQDN Parameter
Parameter
Notes
FQDN
The FQDN (Fully Qualified Domain Name) value as defined in the Prime
Performance Manager Server. It may contain the Node or Group, or the
corresponding “Var Name (key)” found in the ProcessDBSummary section of
the report definition XML file along followed by a specific value.
Format:
Node=[host or IP],[other keys as defined in the corresponding report XML
file]
Node=[host or IP],Group=[group name],[other keys as defined in the
corresponding report XML file]
Group=[group name]
[Var name as defined in the corresponding report XML file]=[value].
Examples of valid formatted FQDN for some reports:
FQDN=Node=em1941kbf.cisco.com
FQDN=Node=10.74.125.210
Performance Manager Server. It may contain the Node or Group, or the
corresponding “Var Name (key)” found in the ProcessDBSummary section of
the report definition XML file along followed by a specific value.
Format:
Node=[host or IP],[other keys as defined in the corresponding report XML
file]
Node=[host or IP],Group=[group name],[other keys as defined in the
corresponding report XML file]
Group=[group name]
[Var name as defined in the corresponding report XML file]=[value].
Examples of valid formatted FQDN for some reports:
FQDN=Node=em1941kbf.cisco.com
FQDN=Node=10.74.125.210