TimeSeriesResource Resource

GET /timeseries

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.

Request Parameters
name type description default
from query Start of the period to query in ISO 8601 format (defaults to 5 minutes before the end of the period). n/a
query query Tsquery to run against the CM time-series data store. n/a
to query End of the period to query in ISO 8601 format (defaults to current time). now
Response Body
media type data type description
application/json ApiTimeSeriesResponseList (JSON) List of time series that match the tsquery.

GET /timeseries

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.

Request Parameters
name type description default
contentType query 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. application/json
desiredRollup query 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. RAW
from query Start of the period to query in ISO 8601 format (defaults to 5 minutes before the end of the period). n/a
mustUseDesiredRollup query If set then the tsquery will return data with the desired aggregate rollup level. false
query query Tsquery to run against the CM time-series data store. n/a
to query End of the period to query in ISO 8601 format (defaults to current time). now
Response Body
media type data type description
application/json ApiTimeSeriesResponseList (JSON) List of time series that match the tsquery.

POST /timeseries

Retrieve time-series data from the Cloudera Manager (CM) time-series data store accepting HTTP POST request. This method differs from queryTimeSeries() in v6 that this could accept query strings that are longer than HTTP GET request limit. Available since API v11.

Request Body
media type data type description
application/json ApiTimeSeriesRequest (JSON) Request object containing information used when retrieving timeseries data.
Response Body
media type data type description
application/json ApiTimeSeriesResponseList (JSON) List of time series that match the tsquery.

GET /timeseries/entityTypeAttributes

Retrieve all metric entity type attributes monitored by Cloudera Manager.

Available since API v11.

Response Body
media type data type description
application/json ApiTimeSeriesEntityAttributeList (JSON) List of time series entity attributes.

GET /timeseries/entityTypes

Retrieve all metric entity types monitored by Cloudera Manager. It is guaranteed that parent types appear before their children.

Available since API v11.

Response Body
media type data type description
application/json ApiTimeSeriesEntityTypeList (JSON) List of time series entity type.

GET /timeseries/schema

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.

Response Body
media type data type description
application/json ApiMetricSchemaList (JSON) List of metric schema.