com.cloudera.api.v1

Interface NameservicesResource

All Known Subinterfaces:

NameservicesResourceV11, NameservicesResourceV14

public interface NameservicesResource

Method Summary

Methods

Modifier and Type	Method and Description
ApiMetricList	getMetrics(String nameservice, String from, String to, List<String> metrics, DataView dataView) Deprecated. This endpoint is not supported as of v6. Use the timeseries API instead. To get all metrics for a nameservice with the timeseries API use the query: 'select * where nameserviceName = $NAMESERVICE_NAME'. To get specific metrics for a nameservice use a comma-separated list of the metric names as follows: 'select $METRIC_NAME1, $METRIC_NAME2 where nameserviceName = $NAMESERVICE_NAME'. For more information see the tsquery language documentation.
ApiNameserviceList	listNameservices(DataView dataView) List the nameservices of an HDFS service.
ApiNameservice	readNameservice(String nameservice) Retrieve information about a nameservice.

Method Detail

listNameservices

@Path(value="/")
ApiNameserviceList listNameservices(DataView dataView)

List the nameservices of an HDFS service.

Parameters:

dataView - The view of the data to materialize, either "summary" or "full".

Returns:

List of nameservices.

readNameservice

@Path(value="/{nameservice}")
ApiNameservice readNameservice(String nameservice)

Retrieve information about a nameservice.

Parameters:

nameservice - The nameservice to retrieve.

Returns:

Details of the nameservice.

getMetrics

@Deprecated
@Path(value="/{nameservice}/metrics")
ApiMetricList getMetrics(String nameservice,
                                       String from,
                                       String to,
                                       List<String> metrics,
                                       DataView dataView)

Deprecated. This endpoint is not supported as of v6. Use the timeseries API instead. To get all metrics for a nameservice with the timeseries API use the query:

'select * where nameserviceName = $NAMESERVICE_NAME'.

To get specific metrics for a nameservice use a comma-separated list of the metric names as follows:

'select $METRIC_NAME1, $METRIC_NAME2 where nameserviceName = $NAMESERVICE_NAME'.

For more information see the tsquery language documentation.

Fetch metric readings for a particular nameservice.

By default, this call will look up all metrics available. If only specific metrics are desired, use the metrics parameter.

By default, the returned results correspond to a 5 minute window based on the provided end time (which defaults to the current server time). The from and to parameters can be used to control the window being queried. A maximum window of 3 hours is enforced.

When requesting a "full" view, aside from the extended properties of the returned metric data, the collection will also contain information about all metrics available, even if no readings are available in the requested window.

Parameters:

nameservice - The nameservice.

from - Start of the period to query.

to - End of the period to query.

metrics - Filter for which metrics to query.

dataView - The view of the data to materialize, either "summary" or "full".

Returns:

List of readings from the monitors.