mirror of https://github.com/iSharkFly-Docs/opensearch-docs-cn synced 2025-02-07 04:58:09 +00:00

add operation to titles to differentiate from the API group acronym (#1750 )

* add operation to titles to differentiate from the API group acronym

Signed-off-by: alicejw <alicejw@amazon.com>

* update frontmatter with new page title

Signed-off-by: alicejw <alicejw@amazon.com>

* for updates per issue https://github.com/opensearch-project/documentation-website/issues/1713

Signed-off-by: alicejw <alicejw@amazon.com>

* to rename section title in left nav TOC to remove acronym definition and update each page frontmatter accordingly

Signed-off-by: alicejw <alicejw@amazon.com>

* to update page title per AWS Style Guide suggestion to only spell out the acronym the first time it's used in a sentence, not on the page title

Signed-off-by: alicejw <alicejw@amazon.com>

Signed-off-by: alicejw <alicejw@amazon.com>

2022-10-31 09:21:32 -07:00

1.8 KiB

Raw Blame History

layout	title	parent	nav_order	has_children
default	CAT nodes operation	CAT API	40	false

CAT nodes

Introduced 1.0 {: .label .label-purple }

The CAT nodes operation lists node-level information, including node roles and load metrics.

A few important node metrics are pid, name, cluster_manager, ip, port, version, build, jdk, along with disk, heap, ram, and file_desc.

Example

GET _cat/nodes?v

Path and HTTP methods

GET _cat/nodes

URL parameters

All CAT nodes URL parameters are optional.

In addition to the common URL parameters, you can specify the following parameters:

Parameter	Type	Description
bytes	Byte size	Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see Supported units.
full_id	Boolean	If true, return the full node ID. If false, return the shortened node ID. Defaults to false.
local	Boolean	Whether to return information from the local node only instead of from the cluster_manager node. Default is false.
cluster_manager_timeout	Time	The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.
time	Time	Specify the units for time. For example, `5d` or `7h`. For more information, see Supported units.
include_unloaded_segments	Boolean	Whether to include information from segments not loaded into memory. Default is false.

Response

ip       |   heap.percent | ram.percent | cpu load_1m | load_5m | load_15m | node.role | node.roles |     master |  name
10.11.1.225  |         31   |    32  | 0  |  0.00  |  0.00   | di  | data,ingest,ml  | - |  data-e5b89ad7

1.8 KiB Raw Blame History