Nodes feature usage APIedit
Returns information on the usage of features.
Requestedit
GET /_nodes/usage
GET /_nodes/<node_id>/usage
GET /_nodes/usage/<metric>
GET /_nodes/<node_id>/usage/<metric>
Prerequisitesedit
-
If the Elasticsearch security features are enabled, you must have the
monitorormanagecluster privilege to use this API.
Descriptionedit
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 parametersedit
-
<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 parametersedit
-
master_timeout -
(Optional, time units)
Period to wait for a connection to the master node. If no response is received
before the timeout expires, the request fails and returns an error. Defaults to
30s. -
timeout -
(Optional, time units)
Period to wait for a response. If no response is received before the timeout
expires, the request fails and returns an error. Defaults to
30s.
Examplesedit
Rest action example:
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": {
...
}
}
}
}