NameservicesResourceApi

All URIs are relative to https://localhost/api/v55

getMetrics

ApiMetricList getMetrics(clusterName, nameservice, serviceName, from, metrics, to, view)

Fetch metric readings for a particular nameservice.

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.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.NameservicesResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

NameservicesResourceApi apiInstance = new NameservicesResourceApi();
String clusterName = "clusterName_example"; // String | 
String nameservice = "nameservice_example"; // String | The nameservice.
String serviceName = "serviceName_example"; // String | The service name.
String from = "from_example"; // String | Start of the period to query.
List<String> metrics = Arrays.asList("metrics_example"); // List<String> | Filter for which metrics to query.
String to = "now"; // String | End of the period to query.
String view = "summary"; // String | The view of the data to materialize, either \"summary\" or \"full\".
try {
    ApiMetricList result = apiInstance.getMetrics(clusterName, nameservice, serviceName, from, metrics, to, view);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling NameservicesResourceApi#getMetrics");
    e.printStackTrace();
}

Parameters

Return type

ApiMetricList

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

listNameservices

ApiNameserviceList listNameservices(clusterName, serviceName, view)

List the nameservices of an HDFS service.

List the nameservices of an HDFS service.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.NameservicesResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

NameservicesResourceApi apiInstance = new NameservicesResourceApi();
String clusterName = "clusterName_example"; // String | 
String serviceName = "serviceName_example"; // String | The service name.
String view = "summary"; // String | The view of the data to materialize, either \"summary\" or \"full\".
try {
    ApiNameserviceList result = apiInstance.listNameservices(clusterName, serviceName, view);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling NameservicesResourceApi#listNameservices");
    e.printStackTrace();
}

Parameters

Return type

ApiNameserviceList

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

readNameservice

ApiNameservice readNameservice(clusterName, nameservice, serviceName, view)

Retrieve information about a nameservice.

Retrieve information about a nameservice.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.NameservicesResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

NameservicesResourceApi apiInstance = new NameservicesResourceApi();
String clusterName = "clusterName_example"; // String | 
String nameservice = "nameservice_example"; // String | The nameservice to retrieve.
String serviceName = "serviceName_example"; // String | The service name.
String view = "summary"; // String | The view to materialize. Defaults to 'full'.
try {
    ApiNameservice result = apiInstance.readNameservice(clusterName, nameservice, serviceName, view);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling NameservicesResourceApi#readNameservice");
    e.printStackTrace();
}

Parameters

Return type

ApiNameservice

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json