|
@@ -1,33 +1,67 @@
|
|
|
[[cluster-nodes-usage]]
|
|
|
=== Nodes Feature Usage
|
|
|
|
|
|
-[float]
|
|
|
-==== Nodes usage
|
|
|
+Returns information on the usage of features.
|
|
|
|
|
|
-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]
|
|
|
--------------------------------------------------
|
|
|
GET _nodes/usage
|
|
|
-GET _nodes/nodeId1,nodeId2/usage
|
|
|
--------------------------------------------------
|
|
|
// CONSOLE
|
|
|
// TEST[setup:node]
|
|
|
-// TEST[s/nodeId1,nodeId2/*/]
|
|
|
-
|
|
|
-The first command retrieves usage of all the nodes in the cluster. The
|
|
|
-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:
|
|
|
+The API returns the following response:
|
|
|
|
|
|
[source,js]
|
|
|
--------------------------------------------------
|
|
@@ -61,4 +95,4 @@ been called on the node:
|
|
|
<1> Timestamp for when this nodes usage request was performed.
|
|
|
<2> Timestamp for when the usage information recording was started. This is
|
|
|
equivalent to the time that the node was started.
|
|
|
-<3> Search action has been called 19 times for this node.
|
|
|
+<3> Search action has been called 19 times for this node.
|