# ImpalaQueriesResource Resource

### GET /clusters/{clusterName}/services/{serviceName}/impalaQueries

Returns a list of queries that satisfy the filter

Available since API v4.

Request Parameters
name | type | description | default
--- | --- | --- | ---
clusterName | path |  | n/a
serviceName | path | The name of the service | n/a

filter

query

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))'.

from | query | Start of the period to query in ISO 8601 format (defaults to 5 minutes before the 'to' time). | n/a

limit

query

The maximum number of queries to return. Queries will be returned in the following order:

- All executing queries, ordered from longest to shortest running
- All completed queries order by end time descending.

100

offset | query | 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. | 0
to | query | End of the period to query in ISO 8601 format (defaults to current time). | now

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiImpalaQueryResponse (JSON) | A list of impala queries and warnings

### GET /clusters/{clusterName}/services/{serviceName}/impalaQueries/attributes

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.

Request Parameters
name | type | description | default
--- | --- | --- | ---
clusterName | path |  | n/a
serviceName | path |  | n/a

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiImpalaQueryAttributeList (JSON) |

### GET /clusters/{clusterName}/services/{serviceName}/impalaQueries/{queryId}

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

Available since API v4.

Request Parameters
name | type | description | default
--- | --- | --- | ---
clusterName | path |  | n/a
queryId | path | The queryId to get information about | n/a
serviceName | path |  | n/a

format

query

There are two valid format parameters:

- 'text': this is a text based, human readable representation of the Impala runtime profile.
- 'thrift_encoded': this a compact-thrift, base64 encoded representation of the Impala RuntimeProfile.thrift object. See the Impala documentation for more details.

text

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiImpalaQueryDetailsResponse (JSON) | The query details

### POST /clusters/{clusterName}/services/{serviceName}/impalaQueries/{queryId}/cancel

Cancels an Impala Query.

Available since API v4.

Request Parameters
name | type | description | default
--- | --- | --- | ---
clusterName | path |  | n/a
queryId | path | The queryId to cancel | n/a
serviceName | path | The name of the service | n/a

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiImpalaCancelResponse (JSON) | A warning if there was one. Otherwise null.