cm_client.YarnApplicationsResourceApi

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

get_yarn_application_attributes

ApiYarnApplicationAttributeList get_yarn_application_attributes(cluster_name, service_name)

Returns the list of all attributes that the Service Monitor can associate with YARN applications.

Returns the list of all attributes that the Service Monitor can associate with YARN applications.

Examples of attributes include the user who ran the application and the number of maps completed by the application.

These attributes can be used to search for specific YARN applications through the getYarnApplications API. For example the 'user' attribute could be used in the search 'user = root'. If the attribute is numeric it can also be used as a metric in a tsquery (ie, 'select maps_completed from YARN_APPLICATIONS').

Note that this response is identical for all YARN services.

Available since API v6.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.YarnApplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | 

try:
    # Returns the list of all attributes that the Service Monitor can associate with YARN applications.
    api_response = api_instance.get_yarn_application_attributes(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling YarnApplicationsResourceApi->get_yarn_application_attributes: %s\n" % e)

Parameters

Return type

ApiYarnApplicationAttributeList

Authorization

basic

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_yarn_applications

ApiYarnApplicationResponse get_yarn_applications(cluster_name, service_name, filter=filter, _from=_from, limit=limit, offset=offset, to=to)

Returns a list of applications that satisfy the filter.

Returns a list of applications that satisfy the filter

Available since API v6.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.YarnApplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The name of the service
filter = '' # str | A filter to apply to the applications. A basic filter tests the value of an attribute and looks something like 'executing = true' or 'user = root'. Multiple basic filters can be combined into a complex expression using standard and / or boolean logic and parenthesis. An example of a complex filter is: 'application_duration > 5s and (user = root or user = myUserName'). (optional) (default to )
_from = '_from_example' # str | Start of the period to query in ISO 8601 format (defaults to 5 minutes before the 'to' time). (optional)
limit = 100 # int | The maximum number of applications to return. Applications will be returned in the following order: <ul> <li> All executing applications, ordered from longest to shortest running </li> <li> All completed applications order by end time descending. </li> </ul> (optional) (default to 100)
offset = 0 # int | The offset to start returning applications from. This is useful for paging through lists of applications. Note that this has non-deterministic behavior if executing applications are included in the response because they can disappear from the list while paging. To exclude executing applications from the response and a 'executing = false' clause to your filter. (optional) (default to 0)
to = 'now' # str | End of the period to query in ISO 8601 format (defaults to now). (optional) (default to now)

try:
    # Returns a list of applications that satisfy the filter.
    api_response = api_instance.get_yarn_applications(cluster_name, service_name, filter=filter, _from=_from, limit=limit, offset=offset, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling YarnApplicationsResourceApi->get_yarn_applications: %s\n" % e)

Parameters

Return type

ApiYarnApplicationResponse

Authorization

basic

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

kill_yarn_application

ApiYarnKillResponse kill_yarn_application(application_id, cluster_name, service_name)

Kills an YARN Application.

Kills an YARN Application

Available since API v6.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.YarnApplicationsResourceApi(cm_client.ApiClient(configuration))
application_id = 'application_id_example' # str | The applicationId to kill
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The name of the service

try:
    # Kills an YARN Application.
    api_response = api_instance.kill_yarn_application(application_id, cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling YarnApplicationsResourceApi->kill_yarn_application: %s\n" % e)

Parameters

Return type

ApiYarnKillResponse

Authorization

basic

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]