mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 07:37:19 -04:00
612ce0f996
* (Doc+) Cross-link CAT APIs to parent object --------- Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
133 lines
No EOL
3.9 KiB
Text
133 lines
No EOL
3.9 KiB
Text
[[cat-nodeattrs]]
|
|
=== cat nodeattrs API
|
|
++++
|
|
<titleabbrev>cat nodeattrs</titleabbrev>
|
|
++++
|
|
|
|
[IMPORTANT]
|
|
====
|
|
cat APIs are only intended for human consumption using the command line or {kib}
|
|
console. They are _not_ intended for use by applications. For application
|
|
consumption, use the <<cluster-nodes-info,nodes info API>>.
|
|
====
|
|
|
|
Returns information about <<shard-allocation-filtering,custom node attributes>>.
|
|
|
|
[[cat-nodeattrs-api-request]]
|
|
==== {api-request-title}
|
|
|
|
`GET /_cat/nodeattrs`
|
|
|
|
[[cat-nodeattrs-api-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* If the {es} {security-features} are enabled, you must have the `monitor` or
|
|
`manage` <<privileges-list-cluster,cluster privilege>> to use this API.
|
|
|
|
[[cat-nodeattrs-api-query-params]]
|
|
==== {api-query-parms-title}
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
|
|
+
|
|
--
|
|
If you do not specify which columns to include, the API returns the default columns in the order listed below. If you explicitly specify one or more columns, it only returns the specified columns.
|
|
|
|
Valid columns are:
|
|
|
|
`node`,`name`::
|
|
(Default) Name of the node, such as `DKDM97B`.
|
|
|
|
`host`, `h`::
|
|
(Default) Host name, such as `n1`.
|
|
|
|
`ip`, `i`::
|
|
(Default) IP address, such as `127.0.1.1`.
|
|
|
|
`attr`, `attr.name`::
|
|
(Default) Attribute name, such as `rack`.
|
|
|
|
`value`, `attr.value`::
|
|
(Default) Attribute value, such as `rack123`.
|
|
|
|
`id`, `nodeId`::
|
|
ID of the node, such as `k0zy`.
|
|
|
|
`pid`, `p`::
|
|
Process ID, such as `13061`.
|
|
|
|
`port`, `po`::
|
|
Bound transport port, such as `9300`.
|
|
--
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local]
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
|
|
|
|
|
|
[[cat-nodeattrs-api-example]]
|
|
==== {api-examples-title}
|
|
|
|
[[cat-nodeattrs-api-ex-default]]
|
|
===== Example with default columns
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
GET /_cat/nodeattrs?v=true
|
|
--------------------------------------------------
|
|
// TEST[s/\?v=true/\?v=true&s=node,attr/]
|
|
// Sort the resulting attributes so we can assert on them more easily
|
|
|
|
The API returns the following response:
|
|
|
|
[source,txt]
|
|
--------------------------------------------------
|
|
node host ip attr value
|
|
...
|
|
node-0 127.0.0.1 127.0.0.1 testattr test
|
|
...
|
|
--------------------------------------------------
|
|
// TESTRESPONSE[s/\.\.\.\n$/\n(.+ xpack\\.installed true\n)?\n/]
|
|
// TESTRESPONSE[s/\.\.\.\n/(.+ ml\\..+\n)*/ non_json]
|
|
// If xpack is not installed then neither ... with match anything
|
|
// If xpack is installed then the first ... contains ml attributes
|
|
// and the second contains xpack.installed=true
|
|
|
|
The `node`, `host`, and `ip` columns provide basic information about each node.
|
|
The `attr` and `value` columns return custom node attributes, one per line.
|
|
|
|
[[cat-nodeattrs-api-ex-headings]]
|
|
===== Example with explicit columns
|
|
|
|
The following API request returns the `name`, `pid`, `attr`, and `value`
|
|
columns.
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
GET /_cat/nodeattrs?v=true&h=name,pid,attr,value
|
|
--------------------------------------------------
|
|
// TEST[s/,value/,value&s=node,attr/]
|
|
// Sort the resulting attributes so we can assert on them more easily
|
|
|
|
The API returns the following response:
|
|
|
|
[source,txt]
|
|
--------------------------------------------------
|
|
name pid attr value
|
|
...
|
|
node-0 19566 testattr test
|
|
...
|
|
--------------------------------------------------
|
|
// TESTRESPONSE[s/19566/\\d*/]
|
|
// TESTRESPONSE[s/\.\.\.\n$/\n(.+ xpack\\.installed true\n)?\n/]
|
|
// TESTRESPONSE[s/\.\.\.\n/(.+ ml\\..+\n)*/ non_json]
|
|
// If xpack is not installed then neither ... with match anything
|
|
// If xpack is installed then the first ... contains ml attributes
|
|
// and the second contains xpack.installed=true |