cm_client.ImpalaQueriesResourceApi

All URIs are relative to /api/v57

cancel_impala_query

ApiImpalaCancelResponse cancel_impala_query(cluster_name, query_id, service_name)

Cancels an Impala Query.

Cancels an Impala Query.

Available since API v4.

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.ImpalaQueriesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
query_id = 'query_id_example' # str | The queryId to cancel
service_name = 'service_name_example' # str | The name of the service

try:
    # Cancels an Impala Query.
    api_response = api_instance.cancel_impala_query(cluster_name, query_id, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImpalaQueriesResourceApi->cancel_impala_query: %s\n" % e)

Parameters

Return type

ApiImpalaCancelResponse

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_impala_queries

ApiImpalaQueryResponse get_impala_queries(cluster_name, service_name, filter=filter, _from=_from, limit=limit, offset=offset, to=to)

Returns a list of queries that satisfy the filter.

Returns a list of queries that satisfy the filter

Available since API v4.

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.ImpalaQueriesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The name of the service
filter = 'filter_example' # str | A filter to apply to the queries. A basic filter tests the value of an attribute and looks something like 'rowsFetched = 1' 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: 'query_duration > 5s and (user = root or user = myUserName)'. An example of expected full query string in requested URL is: '?filter=(query_duration > 5s and (user = root or user = myUserName))'. (optional)
_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 queries to return. Queries will be returned in the following order: <ul> <li> All executing queries, ordered from longest to shortest running </li> <li> All completed queries order by end time descending. </li> </ul> (optional) (default to 100)
offset = 0 # int | The offset to start returning queries from. This is useful for paging through lists of queries. Note that this has non-deterministic behavior if executing queries are included in the response because they can disappear from the list while paging. To exclude executing queries 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 current time). (optional) (default to now)

try:
    # Returns a list of queries that satisfy the filter.
    api_response = api_instance.get_impala_queries(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 ImpalaQueriesResourceApi->get_impala_queries: %s\n" % e)

Parameters

Return type

ApiImpalaQueryResponse

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_impala_query_attributes

ApiImpalaQueryAttributeList get_impala_query_attributes(cluster_name, service_name)

Returns the list of all attributes that the Service Monitor can associate with Impala queries.

Returns the list of all attributes that the Service Monitor can associate with Impala queries.

Examples of attributes include the user who issued the query and the number of HDFS bytes read by the query.

These attributes can be used to search for specific Impala queries through the getImpalaQueries 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 hdfs_bytes_read from IMPALA_QUERIES').

Note that this response is identical for all Impala 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.ImpalaQueriesResourceApi(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 Impala queries.
    api_response = api_instance.get_impala_query_attributes(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImpalaQueriesResourceApi->get_impala_query_attributes: %s\n" % e)

Parameters

Return type

ApiImpalaQueryAttributeList

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_query_details

ApiImpalaQueryDetailsResponse get_query_details(cluster_name, query_id, service_name, format=format)

Returns details about the query.

Returns details about the query. Not all queries have details, check the detailsAvailable field from the getQueries response.

Available since API v4.

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.ImpalaQueriesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
query_id = 'query_id_example' # str | The queryId to get information about
service_name = 'service_name_example' # str | 
format = 'text' # str | There are two valid format parameters: <ul> <li> 'text': this is a text based, human readable representation of the Impala runtime profile. </li> <li> 'thrift_encoded': this a compact-thrift, base64 encoded representation of the Impala RuntimeProfile.thrift object. See the Impala documentation for more details. </li> </ul> (optional) (default to text)

try:
    # Returns details about the query.
    api_response = api_instance.get_query_details(cluster_name, query_id, service_name, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImpalaQueriesResourceApi->get_query_details: %s\n" % e)

Parameters

Return type

ApiImpalaQueryDetailsResponse

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]