Get feature usage information
- GET /_nodes/{node_id}/usage/{metric}
- GET /_nodes/{node_id}/usage
- GET /_nodes/usage/{metric}
- GET /_nodes/usage
- Cluster privileges:
monitor,manage
Path Parameters
-
node_idNodeId | NodeIdoptional -
A comma-separated list of node IDs or names to limit the returned information. Use
_localto return information from the node you're connecting to, leave empty to get information from all nodes.Leave it out to use
/_nodes/usage. -
metricstring | stringoptional -
Limits the information returned to the specific metrics. A comma-separated list of the following options:
_all,rest_actions.Leave it out to use
/_nodes/usage.
Query Parameters
-
timeoutstring Duration · default: 30s Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
Response
-
_nodesNodeStatistics -
Contains statistics about the number of nodes selected by the request’s node filters.
-
failuresErrorCause -
typestringrequired -
The type of error
-
reasonstringnullable -
A human-readable explanation of the error, in English.
-
stack_tracestring -
The server stack trace. Present only if the
error_trace=trueparameter was sent with the request. -
caused_byErrorCause -
root_causeErrorCause -
suppressedErrorCause -
totalnumberrequired -
Total number of nodes selected by the request.
-
successfulnumberrequired -
Number of nodes that responded successfully to the request.
-
failednumberrequired -
Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response.
-
cluster_namestring Namerequired -
nodesmap string to NodeUsagerequired -
<string>NodeUsage -
rest_actionsmap string to numberrequired -
The total number of times each REST endpoint has been called on this node since the last restart. Note that the REST endpoint names are not considered stable.
-
sinceEpochTimeUnitMillisrequired -
The timestamp for when the collection of these statistics started.
-
timestampEpochTimeUnitMillisrequired -
The timestamp for when these statistics were collected.
-
aggregationsmap string to objectrequired -
The total number of times search aggregations have been called on this node since the last restart.