com.cloudera.api.v4
Interface TimeSeriesResource

All Known Subinterfaces:
TimeSeriesResourceV11, TimeSeriesResourceV6

public interface TimeSeriesResource


Method Summary
 ApiMetricSchemaList getMetricSchema()
          Retrieve schema for all metrics

The schema is fixed for a product version.

 ApiTimeSeriesResponseList queryTimeSeries(String query, String from, String to)
          Retrieve time-series data from the Cloudera Manager (CM) time-series data store using a tsquery.
 

Method Detail

queryTimeSeries

@Path(value="/")
ApiTimeSeriesResponseList queryTimeSeries(String query,
                                               String from,
                                               String to)
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 v4.

Parameters:
query - Tsquery to run against the CM time-series data store.
from - Start of the period to query in ISO 8601 format (defaults to 5 minutes before the end of the period).
to - End of the period to query in ISO 8601 format (defaults to current time).
Returns:
List of time series that match the tsquery.

getMetricSchema

@Path(value="/schema")
ApiMetricSchemaList getMetricSchema()
Retrieve schema for all metrics

The schema is fixed for a product version. The schema may change for an API versions

Available since API v4.

Returns:
List of metric schema.


Copyright © Cloudera, Inc. Released under Apache License, Version 2.0.