Metrics Engine REST API Reference

UnboundID Logo

/sla/ldap/{slaName}

GET

Available Since: 4.0

Retrieve a specific SLA included its current status and optionally including historical data as requested by the query parameters.

Parameters

name description type default
slaName The name of the SLA to retrieve. path
startTime The start time for the requested data. This value may be in a relative form which will be calculated relative to endTime, or it may be in an absolute form using ISO8601 format. Relative form uses the syntax: -N[mhdwMy] which is interpreted to mean N time-units before endTime. Absolute form uses the ISO8601 syntax of

YYYY-MM-DDThh:mm:ss

where you can specify a partial date by omitting fields on the right (without skipping any fields). For example, 2013-01-01 is a valid timestamp that mean midnight on January 1st 2013.

query
endTime The end time for the requested data. If not specified, an endTime of 'now' is used. This value may be in a relative form which will be calculated relative to now, or it may be in an absolute form using ISO8601 format. Relative form uses the syntax: -N[mhdwMy] which is interpreted to mean N time-units before now where now is the current time on the Metrics Engine server. Absolute form uses the ISO8601 syntax of

YYYY-MM-DDThh:mm:ss

where you can specify a partial string by omitting fields on the right (without skipping any fields). For example, 2013-01-01 is a valid timestamp that mean midnight on January 1st 2013.

query
maxIntervals The maximum number of time intervals to include in the result. If maxIntervals is 1, all data over the requested time range is reduced to a single number. Otherwise the time range is evenly divided into maxIntervals intervals. A time range farther in the past will be forced to use data with less time granularity, so it is possible that the resulting chart will have fewer than maxIntervals data points, but it will never have more. query 100
historical Specifies what historical information should be included. Valid values are: 'time', 'histogram', 'nines'. To specify more than one value include this parameter multiple times. query
pivot When specified a pivot will separate the metric along distinct dimension values. If not specified, all dimension values are aggregated together. Valid pivot values are 'instance', 'op-type' and 'histogram'. query
hint Query hints to use. Must be one of the following values:
  • MOST_CURRENT - use the most current data that fits the range
  • AGGREGATE_REQUIRES_ALL - every point in the results requires data from all sub-series.
query

Response Body

result: LDAPSLA
media types: application/xml
application/json

The retrieved SLA.

Status Codes

code description
200 Success
400 Invalid parameter
404 SLA not found
500 Internal error