Get feature usage information

Auth

Required authorization

Cluster privileges monitor manage

Path parameters

node_id union string | string[] optional

A comma-separated list of node IDs or names to limit the returned information. Use _local to return information from the node you're connecting to, leave empty to get information from all nodes.

Leave it out to use /_nodes/usage.

metric union enum | enum[] optional

Limits the information returned to the specific metrics. A comma-separated list of the following options: _all, rest_actions, aggregations.

Supported values include: _all, rest_actions, aggregations

Leave it out to use /_nodes/usage.

Values: _all rest_actions aggregations

Query parameters

timeout string · 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

application/json
_nodes object

Contains statistics about the number of nodes selected by the request’s node filters.

failures object[]
type string required

The type of error

reason union string nullable

A human-readable explanation of the error, in English.

One of: string
stack_trace string

The server stack trace. Present only if the error_trace=true parameter was sent with the request.

caused_by object
Same fields as failures in _nodes
root_cause object[]
Same fields as failures in _nodes
suppressed object[]
Same fields as failures in _nodes
total number required

Total number of nodes selected by the request.

successful number required

Number of nodes that responded successfully to the request.

failed number required

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_name string required
nodes map string to object required
<string> object
rest_actions map string to number required

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.

since number required

The timestamp for when the collection of these statistics started.

timestamp number required

The timestamp for when these statistics were collected.

aggregations map string to object required

The total number of times search aggregations have been called on this node since the last restart.