[DOCS] Reformats nodes feature usage API (#45539)
Co-Authored-By: James Rodewig <james.rodewig@elastic.co>
This commit is contained in:
parent
0db5af5f65
commit
8142ca82f1
|
@ -1,33 +1,67 @@
|
||||||
[[cluster-nodes-usage]]
|
[[cluster-nodes-usage]]
|
||||||
=== Nodes Feature Usage
|
=== Nodes Feature Usage
|
||||||
|
|
||||||
[float]
|
Returns information on the usage of features.
|
||||||
==== Nodes usage
|
|
||||||
|
|
||||||
The cluster nodes usage API allows to retrieve information on the usage
|
|
||||||
of features for each node.
|
[[cluster-nodes-usage-api-request]]
|
||||||
|
==== {api-request-title}
|
||||||
|
|
||||||
|
`GET /_nodes/usage` +
|
||||||
|
|
||||||
|
`GET /_nodes/{node_id}/usage` +
|
||||||
|
|
||||||
|
`GET /_nodes/usage/{metric}` +
|
||||||
|
|
||||||
|
`GET /_nodes/{node_id}/usage/{metric}`
|
||||||
|
|
||||||
|
|
||||||
|
[[cluster-nodes-usage-api-desc]]
|
||||||
|
==== {api-description-title}
|
||||||
|
|
||||||
|
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
|
||||||
|
<<cluster-nodes,here>>.
|
||||||
|
|
||||||
|
|
||||||
|
[[cluster-nodes-usage-api-path-params]]
|
||||||
|
==== {api-path-parms-title}
|
||||||
|
|
||||||
|
`{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.
|
||||||
|
--
|
||||||
|
|
||||||
|
include::{docdir}/rest-api/common-parms.asciidoc[tag=node-id]
|
||||||
|
|
||||||
|
|
||||||
|
[[cluster-nodes-usage-api-query-params]]
|
||||||
|
==== {api-query-parms-title}
|
||||||
|
|
||||||
|
include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
||||||
|
|
||||||
|
|
||||||
|
[[cluster-nodes-usage-api-example]]
|
||||||
|
==== {api-examples-title}
|
||||||
|
|
||||||
|
Rest action example:
|
||||||
|
|
||||||
[source,js]
|
[source,js]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
GET _nodes/usage
|
GET _nodes/usage
|
||||||
GET _nodes/nodeId1,nodeId2/usage
|
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
// CONSOLE
|
// CONSOLE
|
||||||
// TEST[setup:node]
|
// TEST[setup:node]
|
||||||
// TEST[s/nodeId1,nodeId2/*/]
|
|
||||||
|
|
||||||
The first command retrieves usage of all the nodes in the cluster. The
|
The API returns the following response:
|
||||||
second command selectively retrieves nodes usage of only `nodeId1` and
|
|
||||||
`nodeId2`. All the nodes selective options are explained
|
|
||||||
<<cluster-nodes,here>>.
|
|
||||||
|
|
||||||
[float]
|
|
||||||
[[rest-usage]]
|
|
||||||
===== REST actions usage information
|
|
||||||
|
|
||||||
The `rest_actions` field in the response contains a map of the REST
|
|
||||||
actions classname with a count of the number of times that action has
|
|
||||||
been called on the node:
|
|
||||||
|
|
||||||
[source,js]
|
[source,js]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
|
|
Loading…
Reference in New Issue