NameservicesResource Resource

GET /clusters/{clusterName}/services/{serviceName}/nameservices

List the nameservices of an HDFS service.

Request Parameters
name type description default
clusterName path n/a
serviceName path The service name. n/a
view query The view of the data to materialize, either "summary" or "full". summary
Response Body
media type data type description
application/json ApiNameserviceList (JSON) List of nameservices.

GET /clusters/{clusterName}/services/{serviceName}/nameservices/{nameservice}

Retrieve information about a nameservice.

Request Parameters
name type description default
clusterName path n/a
nameservice path The nameservice to retrieve. n/a
serviceName path The service name. n/a
view query The view to materialize. Defaults to 'full'. summary
Response Body
media type data type description
application/json ApiNameservice (JSON) Details of the nameservice.

GET /clusters/{clusterName}/services/{serviceName}/nameservices/{nameservice}/metrics

This method has been 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.

Request Parameters
name type description default
clusterName path n/a
nameservice path The nameservice. n/a
serviceName path The service name. n/a
from query Start of the period to query. n/a
metrics query Filter for which metrics to query. n/a
to query End of the period to query. now
view query The view of the data to materialize, either "summary" or "full". summary
Response Body
media type data type description
application/json ApiMetricList (JSON) List of readings from the monitors.