Merge pull request #592 from lukas-vlcek/fix_591

Fixing Nodes APIs issues
This commit is contained in:
Naarcha-AWS 2022-05-20 12:06:27 -05:00 committed by GitHub
commit 5ca9327c97
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 8 additions and 8 deletions

View File

@ -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]({{site.url}}{{site.baseurl}}/opensearch/rest-api/nodes-apis/index/#node-filters) that OpenSearch uses to filter results.
Although the `master` node is now called `cluster_manager` for version 2.0, we retained the `master` field for backwards compatibility. If you have a node that has either a `master` role or a `cluster_manager` role, the `count` increases for both fields by 1. To see an example node count increase, see the Response sample.

View File

@ -1,6 +1,6 @@
---
layout: default
title: Nodes API
title: Nodes APIs
parent: REST API reference
has_children: true
nav_order: 5

View File

@ -29,13 +29,13 @@ You can include the following URL parameters in your request. All parameters are
Parameter | Type | Description
:--- |:----------| :---
nodeId | String | A comma-separated list of node IDs to filter results. Supports [node filters](../index/#node-filters). Defaults to `_all`.
nodeId | String | A comma-separated list of node IDs to filter results. Supports [node filters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/nodes-apis/index/#node-filters). Defaults to `_all`.
snapshots | Integer | Number of samples of thread stacktraces. Defaults to `10`.
interval | TimeValue | Interval between consecutive samples. Defaults to `500ms`.
threads | Integer | A number of top busiest threads to return information about. Defaults to `3`.
ignore_idle_threads | Boolean | Dont show threads that are in known-idle states, such as waiting on a socket select or pulling from an empty task queue. Defaults to `true`.
type | String | Supported thread types are `cpu`, `wait`, or `block`. Defaults to `cpu`.
timeout | TimeValue | A request [timeout](../index/#timeout). Defaults to `30s`.
timeout | TimeValue | A request [timeout]({{site.url}}{{site.baseurl}}/opensearch/rest-api/nodes-apis/index/#timeout). Defaults to `30s`.
## Response

View File

@ -48,15 +48,15 @@ You can include the following URL parameters in your request. All parameters are
Parameter | Type | Description
:--- |:-------| :---
nodeId | String | A comma-separated list of nodeIds to filter results. Supports [node filters](../index/#node-filters). Defaults to `_all`.
nodeId | String | A comma-separated list of nodeIds to filter results. Supports [node filters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/nodes-apis/index/#node-filters). Defaults to `_all`.
metrics | String | A comma-separated list of metric groups that will be included in the response. For example `jvm,thread_pools`. Defaults to all metrics.
timeout | TimeValue | A request [timeout](../index/#timeout). Defaults to `30s`.
timeout | TimeValue | A request [timeout]({{site.url}}{{site.baseurl}}/opensearch/rest-api/nodes-apis/index/#timeout). Defaults to `30s`.
The following are listed for all available metric groups:
Metric | Description
:--- |:----
`settings` | A node's settings. This is combination of the default settings, custom settings from [configuration file](../../../configuration/#configuration-file) and dynamically [updated settings](../../../configuration/#update-cluster-settings-using-the-api).
`settings` | A node's settings. This is combination of the default settings, custom settings from [configuration file]({{site.url}}{{site.baseurl}}/opensearch/configuration/#configuration-file) and dynamically [updated settings]({{site.url}}{{site.baseurl}}/opensearch/configuration/#update-cluster-settings-using-the-api).
`os` | Static information about the host OS, including version, processor architecture and available/allocated processors.
`process` | Contains process OD.
`jvm` | Detailed static information about running JVM, including arguments.
@ -65,7 +65,7 @@ Metric | Description
`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).
`aggregations` | Information about available [aggregations]({{site.url}}{{site.baseurl}}/opensearch/aggregations).
`indices` | Static index settings configured at the node level.
## Response