Add editorial review
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
This commit is contained in:
parent
03807527eb
commit
6ad4d00060
|
@ -31,7 +31,7 @@ All cluster stats parameters are optional.
|
|||
|
||||
Parameter | Type | Description
|
||||
:--- | :--- | :---
|
||||
<node-filters> | List | A comma-separated list of [node-filters](../nodes-apis/index/#node-filters) that OpenSearch uses to filter results.
|
||||
<node-filters> | List | A comma-separated list of [node filters](../nodes-apis/index/#node-filters) that OpenSearch uses to filter results.
|
||||
|
||||
|
||||
## Response
|
||||
|
|
|
@ -1,12 +1,12 @@
|
|||
---
|
||||
layout: default
|
||||
title: Nodes APIs
|
||||
title: Nodes API
|
||||
parent: REST API reference
|
||||
has_children: true
|
||||
nav_order: 5
|
||||
---
|
||||
|
||||
# Nodes APIs
|
||||
# Nodes API
|
||||
|
||||
The nodes API makes it possible to retrieve information about individual nodes within your cluster. It supports standard parameters such `{timeout}` and `{node-filters}`.
|
||||
|
||||
|
@ -26,10 +26,10 @@ Parameter | Type | Description
|
|||
:--- |:-------| :---
|
||||
{node-filters} | String | A comma-separated list of resolution mechanisms that OpenSearch uses to identify cluster nodes.
|
||||
|
||||
Node filters support several node resolution mechanisms:
|
||||
Node filters support several node resolution mechanisms.
|
||||
|
||||
- Pre-defined constants: `_local`, `_cluster_manager`, or `_all`
|
||||
- Exact match for `nodeID`
|
||||
- Pre defined constants: `_local`, `_cluster_manager`, or `_all`
|
||||
- An exact match for `nodeID`
|
||||
- A simple case-sensitive wildcard pattern matching for `node-name`, `host-name`, or `host-IP-address`
|
||||
- Node roles where the `<bool>` value is set either to `true` or `false`):
|
||||
- `cluster_manager:<bool>`
|
||||
|
@ -42,13 +42,13 @@ Node filters support several node resolution mechanisms:
|
|||
|
||||
Resolution mechanisms are applied sequentially in the order specified by the client. Each mechanism specification can either add or remove nodes.
|
||||
|
||||
If you want to get statistics from the elected cluster-manager node only, use:
|
||||
If you want to get statistics from the elected cluster manager node only, use the following:
|
||||
|
||||
```bash
|
||||
GET /_nodes/_cluster_manager/stats
|
||||
```
|
||||
|
||||
If you want to get statistics from nodes that are data-only nodes, use:
|
||||
If you want to get statistics from nodes that are data-only nodes, use the following:
|
||||
|
||||
```bash
|
||||
GET /_nodes/data:true/stats
|
||||
|
@ -58,7 +58,7 @@ GET /_nodes/data:true/stats
|
|||
|
||||
The order of resolution mechanisms is applied sequentially, and each can add or remove nodes. The following examples yield different results:
|
||||
|
||||
If you want to get statistics from all the nodes but the cluster manager node, use:
|
||||
If you want to get statistics from all the nodes but the cluster manager node, use the following:
|
||||
|
||||
```bash
|
||||
GET /_nodes/_all,cluster_manager:false/stats
|
||||
|
|
|
@ -61,8 +61,8 @@ Metric | Description
|
|||
`process` | Contains process OD.
|
||||
`jvm` | Detailed static information about running JVM, including arguments.
|
||||
`thread_pool` | Configured options for all individual thread pools.
|
||||
`transport` | Mostly static information about transport layer.
|
||||
`http` | Mostly static information about http layer.
|
||||
`transport` | Mostly static information about the transport layer.
|
||||
`http` | Mostly static information about the HTTP layer.
|
||||
`plugins` | Information about installed plugins and modules.
|
||||
`ingest` | Information about ingest pipelines and available ingest processors.
|
||||
`aggregations` | Information about available [aggregations](../../../aggregations).
|
||||
|
@ -82,10 +82,10 @@ ip | A node host ip address.
|
|||
version | A node OpenSearch version.
|
||||
build_type | A build type, like `rpm`,`docker`, `zip`, etc.
|
||||
build_hash | A git commit hash of the build.
|
||||
roles | A node roles.
|
||||
roles | A node's role.
|
||||
attributes | A node attributes.
|
||||
|
||||
The response also contains one or more metric groups depending on `{metrics}` request parameter.
|
||||
The response also contains one or more metric groups, depending on the `{metrics}` request parameter.
|
||||
|
||||
```json
|
||||
GET /_nodes/master:true/process,transport?pretty
|
||||
|
|
Loading…
Reference in New Issue