com.cloudera.api.v6

Interface TimeSeriesResourceV6

All Superinterfaces:

TimeSeriesResource

public interface TimeSeriesResourceV6
extends TimeSeriesResource

Method Summary

Methods

Modifier and Type	Method and Description
DashboardsResource	getDashboardsResource()
javax.ws.rs.core.Response	queryTimeSeries(String query, String from, String to, String contentType, String desiredRollup, boolean mustUseDesiredRollup) Retrieve time-series data from the Cloudera Manager (CM) time-series data store using a tsquery.

Methods inherited from interface com.cloudera.api.v4.TimeSeriesResource

getMetricSchema, queryTimeSeries

Method Detail

queryTimeSeries

@Path(value="/")
javax.ws.rs.core.Response queryTimeSeries(String query,
                                             String from,
                                             String to,
                                             String contentType,
                                             String desiredRollup,
                                             boolean mustUseDesiredRollup)

Retrieve time-series data from the Cloudera Manager (CM) time-series data store using a tsquery. Please see the tsquery language documentation.

Available since API v6.

Parameters:

query - Tsquery to run against the CM time-series data store.

from - Start of the period to query (defaults to 5 minutes before the end of the period).

to - End of the period to query (defaults to current time).

contentType - to return the response in. The content types "application/json" and "text/csv" are supported. This defaults to "application/json". If "text/csv" is specified then we return one row per time series data point, and we don't return any of the metadata.

desiredRollup - Aggregate rollup level desired for the response data. Valid values are RAW, TEN_MINUTELY, HOURLY, SIX_HOURLY, DAILY, and WEEKLY. Note that if the mustUseDesiredRollup parameter is not set, then the monitoring server can decide to return a different rollup level.

mustUseDesiredRollup - If set then the tsquery will return data with the desired aggregate rollup level.

Returns:

List of time series that match the tsquery.

getDashboardsResource

@Path(value="/dashboards")
DashboardsResource getDashboardsResource()

Returns:

The dashboards resource handler.