This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« Cluster update settings API Nodes hot threads API »

› › ›

Nodes feature usage API

edit

Nodes feature usage API

edit

Returns information on the usage of features.

Request

edit

GET /_nodes/usage

GET /_nodes/<node_id>/usage

GET /_nodes/usage/<metric>

GET /_nodes/<node_id>/usage/<metric>

Prerequisites

edit

If the Elasticsearch security features are enabled, you must have the monitor or manage cluster privilege to use this API.

Description

edit

The cluster nodes usage API allows you to retrieve information on the usage of features for each node. All the nodes selective options are explained here.

Path parameters

edit

<metric>

(Optional, string) Limits the information returned to the specific metrics. A comma-separated list of the following options:

_all: Returns all stats.
rest_actions: Returns the REST actions classname with a count of the number of times that action has been called on the node.

<node_id>

(Optional, string) Comma-separated list of node IDs or names used to limit returned information.

Query parameters

edit

timeout: (Optional, time units) Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its information. However, timed out nodes are included in the response’s _nodes.failed property. Defaults to no timeout.

Examples

edit

Rest action example:

resp = client.nodes.usage()
print(resp)

response = client.nodes.usage
puts response

const response = await client.nodes.usage();
console.log(response);

GET _nodes/usage

The API returns the following response:

{
  "_nodes": {
    "total": 1,
    "successful": 1,
    "failed": 0
  },
  "cluster_name": "my_cluster",
  "nodes": {
    "pQHNt5rXTTWNvUgOrdynKg": {
      "timestamp": 1492553961812, 
      "since": 1492553906606, 
      "rest_actions": {
        "nodes_usage_action": 1,
        "create_index_action": 1,
        "document_get_action": 1,
        "search_action": 19, 
        "nodes_info_action": 36
      },
      "aggregations": {
        ...
      }
    }
  }
}

	Timestamp for when this nodes usage request was performed.
	Timestamp for when the usage information recording was started. This is equivalent to the time that the node was started.
	Search action has been called 19 times for this node.

« Cluster update settings API Nodes hot threads API »