iSharkFly-Docs
/
opensearch-docs-cn
mirror of https://github.com/iSharkFly-Docs/opensearch-docs-cn
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Puts column headers in sentence case (#1989) 

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
This commit is contained in:
kolchfa-aws 2022-11-18 15:25:06 -05:00 committed by GitHub
parent 00dea2d06b
commit 63019c421d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
38 changed files with 1070 additions and 98 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
STYLE_API_TEMPLATE.md
View File

@ -77,10 +77,10 @@ In the example above, the resource is `scroll` and its path parameter is `<scrol
Introduce what the path parameters can do at a high level. Provide a table with parameter names and descriptions. Include a table with the following columns:
*Parameter* – Parameter name in plain font.
*Data Type* – Data type capitalized (such as Boolean, String, or Integer).
*Data type* – Data type capitalized (such as Boolean, String, or Integer).
*Description* – Sentence to describe the parameter function, default values or range of values, and any usage examples.
Parameter | Data Type | Description
Parameter | Data type | Description
:--- | :--- | :---
### Query parameters
@ -97,7 +97,7 @@ Include a paragraph that describes how to use the query parameters with an examp
For GET and DELETE APIs: Introduce what you can do with the optional parameters. Include a table with the same columns as the path parameter table.
Parameter | Data Type | Description
Parameter | Data type | Description
:--- | :--- | :---
### Request fields
@ -106,10 +106,10 @@ For PUT and POST APIs: Introduce what the request fields are allowed to provide
Include a table with these columns:
*Field* – Field name in plain font.
*Data Type* – Data type capitalized (such as Boolean, String, or Integer).
*Data type* – Data type capitalized (such as Boolean, String, or Integer).
*Description* – Sentence to describe the field’s function, default values or range of values, and any usage examples.
Field | Data Type | Description
Field | Data type | Description
:--- | :--- | :---
#### Sample request
@ -190,5 +190,5 @@ The `POST _reindex` request returns the following response fields:
For PUT and POST APIs: Define all allowable response fields that can be returned in the body of the response.
Field | Data Type | Description
Field | Data type | Description
:--- | :--- | :---

12
_api-reference/analyze-apis/perform-text-analysis.md
View File

@ -29,7 +29,7 @@ Although you can issue an analyzer request via both `GET` and `POST` requests, t
You can include the following optional path parameter in your request.
Parameter | Data Type | Description
Parameter | Data type | Description
:--- | :--- | :---
index | String | Index that is used to derive the analyzer.
@ -37,7 +37,7 @@ index | String | Index that is used to derive the analyzer.
You can include the following optional query parameters in your request.
Field | Data Type | Description
Field | Data type | Description
:--- | :--- | :---
analyzer | String | The name of the analyzer to apply to the `text` field. The analyzer can be built in or configured in the index.<br /><br />If `analyzer` is not specified, the analyze API uses the analyzer defined in the mapping of the `field` field.<br /><br />If the `field` field is not specified, the analyze API uses the default analyzer for the index.<br /><br > If no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.
attributes | Array of Strings | Array of token attributes for filtering the output of the `explain` field.
@ -50,7 +50,7 @@ tokenizer | String | Tokenizer for converting the `text` field into tokens.
The following query parameter is required.
Field | Data Type | Description
Field | Data type | Description
:--- | :--- | :---
text | String or Array of Strings | Text to analyze. If you provide an array of strings, the text is analyzed as a multi-value field.
@ -642,14 +642,14 @@ The preceding request is an index API rather than an analyze API. See [DYNAMIC I
The text analysis endpoints return the following response fields.
Field | Data Type | Description
Field | Data type | Description
:--- | :--- | :---
tokens | Array | Array of tokens derived from the `text`. See [token object](#token-object).
detail | Object | Details about the analysis and each token. Included only when you request token details. See [detail object](#detail-object).
#### Token object
Field | Data Type | Description
Field | Data type | Description
:--- | :--- | :---
token | String | The token's text.
start_offset | Integer | The token's starting position within the original text string. Offsets are zero-based.
@ -659,7 +659,7 @@ position | Integer | The token's position within the `tokens` array.
#### Detail object
Field | Data Type | Description
Field | Data type | Description
:--- | :--- | :---
custom_analyzer | Boolean | Whether the analyzer applied to the text is custom or built in.
charfilters | Array | List of character filters applied to the text.

6
_api-reference/index-apis/clear-index-cache.md
View File

@ -15,7 +15,7 @@ If you use the security plugin, you must have the `manage index` privileges.
### Path parameters
| Parameter | Data Type | Description |
| Parameter | Data type | Description |
:--- | :--- | :---
| target | String | Comma-delimited list of data streams, indexes, and index aliases to which cache clearing will be applied. Wildcard expressions (`*`) are supported. To target all data streams and indexes in a cluster, omit this parameter or use `_all` or `*`. Optional. |
@ -24,7 +24,7 @@ If you use the security plugin, you must have the `manage index` privileges.
All query parameters are optional.
| Parameter | Data Type | Description |
| Parameter | Data type | Description |
:--- | :--- | :---
| allow_no_indices | Boolean | Whether to ignore wildcards, index aliases, or `_all` target (`target` path parameter) values that don’t match any indexes. If `false`, the request returns an error if any wildcard expression, index alias, or `_all` target value doesn't match any indexes. This behavior also applies if the request targets include other open indexes. For example, a request where the target is `fig*,app*` returns an error if an index starts with `fig` but no index starts with `app`. Defaults to `true`. |
| expand_wildcards | String | Determines the index types that wildcard expressions can expand to. Accepts multiple values separated by a comma, such as `open,hidden`. Valid values are: <br /><br /> `all` -- Expand to open, closed, and hidden indexes.<br /><br />`open` -- Expand only to open indexes.<br /><br />`closed` -- Expand only to closed indexes<br /><br />`hidden` -- Expand to include hidden indexes. Must be combined with `open`, `closed`, or `both`.<br /><br />`none` -- Expansions are not accepted.<br /><br /> Defaults to `open`. |
@ -105,7 +105,7 @@ The `POST /books,hockey/_cache/clear` request returns the following fields:
The `POST /books,hockey/_cache/clear` request returns the following response fields:
| Field | Data Type | Description |
| Field | Data type | Description |
:--- | :--- | :---
| _shards | Object | Shard information. |
| total | Integer | Total number of shards. |

2
_api-reference/index-apis/dangling-index.md
View File

@ -41,7 +41,7 @@ index-uuid | UUID of index.
Query parameters are optional.
Query parameter | Data Type | Description
Query parameter | Data type | Description
:--- | :--- | :---
accept_data_loss | Boolean | Must be set to `true` for an `import` or `delete` because Opensearch is unaware of where the dangling index data came from.
timeout | Time units | The amount of time to wait for a response. If no response is received in the defined time period, an error is returned. Default is `30` seconds.

2
_api-reference/index-apis/get-settings.md
View File

@ -29,7 +29,7 @@ GET /<target-index>/_settings/<setting>
All update settings parameters are optional.
Parameter | Data Type | Description
Parameter | Data type | Description
:--- | :--- | :---
&lt;target-index&gt; | String | The index to get settings from. Can be a comma-separated list to get settings from multiple indexes, or use `_all` to return settings from all indexes within the cluster.
&lt;setting&gt; | String | Filter to return specific settings.

2
_api-reference/index-apis/put-mapping.md
View File

@ -50,7 +50,7 @@ PUT /sample-index/_mapping?ignore_unavailable
The following table defines the put mapping query parameters:
Parameter | Data Type | Description
Parameter | Data type | Description
:--- | :--- | :---
allow_no_indices | Boolean | Whether to ignore wildcards that don’t match any indexes. Default is `true`.
expand_wildcards | String | Expands wildcard expressions to different indexes. Combine multiple values with commas. Available values are `all` (match all indexes), `open` (match open indexes), `closed` (match closed indexes), `hidden` (match hidden indexes), and `none` (do not accept wildcard expressions), which must be used with `open`, `closed`, or both. Default is `open`.

2
_api-reference/index-apis/update-settings.md
View File

@ -35,7 +35,7 @@ PUT /<target-index>/_settings
All update settings parameters are optional.
Parameter | Data Type | Description
Parameter | Data type | Description
:--- | :--- | :---
allow_no_indices | Boolean | Whether to ignore wildcards that don’t match any indexes. Default is `true`.
expand_wildcards | String | Expands wildcard expressions to different indexes. Combine multiple values with commas. Available values are `all` (match all indexes), `open` (match open indexes), `closed` (match closed indexes), `hidden` (match hidden indexes), and `none` (do not accept wildcard expressions), which must be used with `open`, `closed`, or both. Default is `open`.

4
_api-reference/nodes-apis/nodes-stats.md
View File

@ -578,7 +578,7 @@ GET _nodes/stats/
The following table lists all response fields.
| Field | Data Type | Description |
| Field | Data type | Description |
| :--- | :--- | :--- |
| _nodes | Object | Statistics about the nodes that are returned. |
| _nodes.total | Integer | The total number of nodes for this request. |
@ -591,7 +591,7 @@ The following table lists all response fields.
The `nodes` object contains all nodes that are returned by the request, along with their IDs. Each node has the following properties.
Field | Data Type | Description
Field | Data type | Description
:--- | :--- | :---
timestamp | Integer | The time the nodes statistics were collected, in milliseconds since the epoch.
name | String | The name of the node.

2
_api-reference/rank-eval.md
View File

@ -19,7 +19,7 @@ POST <index_name>/_rank_eval
Query parameters are optional.
Parameter | Data Type | Description
Parameter | Data type | Description
:--- | :--- | :---
ignore_unavailable | Boolean | Defaults to `false`. When set to `false` the response body will return an error if an index is closed or missing.
allow_no_indices | Boolean | Defaults to `true`. When set to `false` the response body will return an error if a wildcard expression points to indexes that are closed or missing.

2
_api-reference/reload-search-analyzer.md
View File

@ -19,7 +19,7 @@ GET /<index>/_reload_search_analyzers
Request body parameters are optional.
Field Type | Data Type | Description
Field Type | Data type | Description
:--- | :--- | :---
allow_no_indices | Boolean | When set to `false`, an error is returned for indexes that are closed or missing and match any wildcard expression. Default is set to `true`.
expand_wildcards | String | Allows you to set the wildcards that can be matched to a type of index. Available options are `open`, `closed`, `all`, `none`, and `hidden`. Default is set to `open`.

10
_api-reference/script-apis/create-stored-script.md
View File

@ -18,7 +18,7 @@ For additional information about Painless scripting, see:
### Path parameters
| Parameter | Data Type | Description |
| Parameter | Data type | Description |
:--- | :--- | :---
| script-id | String | Stored script or search template ID. Must be unique across the cluster. Required. |
@ -26,7 +26,7 @@ For additional information about Painless scripting, see:
All parameters are optional.
| Parameter | Data Type | Description |
| Parameter | Data type | Description |
:--- | :--- | :---
| context | String | Context in which the script or search template is to run. To prevent errors, the API immediately compiles the script or template in this context. |
| cluster_manager_timeout | Time | Amount of time to wait for a connection to the cluster manager. Defaults to 30 seconds. |
@ -34,13 +34,13 @@ All parameters are optional.
### Request fields
| Field | Data Type | Description |
| Field | Data type | Description |
:--- | :--- | :---
| script | Object | Defines the script or search template, its parameters, and its language. See *Script object* below. |
*Script object*
| Field | Data Type | Description |
| Field | Data type | Description |
:--- | :--- | :---
| lang | String | Scripting language. Required. |
| source | String or Object | Required. <br /> <br /> For scripts, a string with the contents of the script. <br /> <br /> For search templates, an object that defines the search template. Supports the same parameters as the [Search]({{site.url}}{{site.baseurl}}/api-reference/search) API request body. Search templates also support Mustache variables. |
@ -107,6 +107,6 @@ To determine whether the script was successfully created, use the [Get stored sc
### Response fields
| Field | Data Type | Description |
| Field | Data type | Description |
:--- | :--- | :---
| acknowledged | Boolean | whether the request was received. |

6
_api-reference/script-apis/delete-script.md
View File

@ -13,13 +13,13 @@ Deletes a stored script
Path parameters are optional.
| Parameter | Data Type | Description |
| Parameter | Data type | Description |
:--- | :--- | :---
| script-id | String | ID of script to delete. |
### Query parameters
| Parameter | Data Type | Description |
| Parameter | Data type | Description |
:--- | :--- | :---
| cluster_manager_timeout | Time | Amount of time to wait for a connection to the cluster manager. Optional, defaults to `30s`. |
| timeout | Time | The period of time to wait for a response. If a response is not received before the timeout value, the request will be dropped.
@ -48,6 +48,6 @@ To determine whether the stored script was successfully deleted, use the [Get st
The <HTTP METHOD> <endpoint> request returns the following response fields:
| Field | Data Type | Description |
| Field | Data type | Description |
:--- | :--- | :---
| acknowledged | Boolean | Whether the delete script request was received. |

8
_api-reference/script-apis/exec-stored-script.md
View File

@ -13,7 +13,7 @@ OpenSearch provides several ways to run a script; the following sections show ho
### Request fields
| Field | Data Type | Description |
| Field | Data type | Description |
:--- | :--- | :---
| query | Object | A filter that specifies documents to process. |
| script_fields | Object | Fields to include in output. |
@ -103,7 +103,7 @@ The `GET books/_search` request returns the following fields:
### Response fields
| Field | Data Type | Description |
| Field | Data type | Description |
:--- | :--- | :---
| took | Integer | How long the operation took in milliseconds. |
| timed_out | Boolean | Whether the operation timed out. |
@ -112,7 +112,7 @@ The `GET books/_search` request returns the following fields:
#### Hits object
| Field | Data Type | Description |
| Field | Data type | Description |
:--- | :--- | :---
| total | Object | Total number of documents processed and their relationship to the `match` request field. |
| max_score | Double | Highest relevance score returned from all the hits. |
@ -120,7 +120,7 @@ The `GET books/_search` request returns the following fields:
#### Document object
| Field | Data Type | Description |
| Field | Data type | Description |
:--- | :--- | :---
| _index | String | Index that contains the document. |
| _id | String | Document ID. |

8
_api-reference/script-apis/get-script-contexts.md
View File

@ -548,20 +548,20 @@ The `GET _script_context` request returns the following fields:
The `GET _script_context` request returns the following response fields:
| Field | Data Type | Description |
| Field | Data type | Description |
:--- | :--- | :---
| contexts | List | A list of all contexts. See [Script object](#script-context). |
#### Script context
| Field | Data Type | Description |
| Field | Data type | Description |
:--- | :--- | :---
| name | String | The context name. |
| methods | List | List of the context's allowable methods. See [Script object](#context-methods). |
#### Context methods
| Field | Data Type | Description |
| Field | Data type | Description |
:--- | :--- | :---
| name | String | Method name. |
| name | String | Type that the method returns (`boolean`, `object`, `number`, and so on). |
@ -569,7 +569,7 @@ The `GET _script_context` request returns the following response fields:
#### Method parameters
| Field | Data Type | Description |
| Field | Data type | Description |
:--- | :--- | :---
| type | String | Parameter data type. |
| name | String | Parameter name. |

2
_api-reference/script-apis/get-script-language.md
View File

@ -90,7 +90,7 @@ The `GET _script_language` request returns the available contexts for each langu
The request contains the following response fields.
Field | Data Type | Description |
Field | Data type | Description |
:--- | :--- | :---
types_allowed | List of strings | The types of scripts that are enabled, determined by the `script.allowed_types` setting. May contain `inline` and/or `stored`.
language_contexts | List of objects | A list of objects, each of which maps a supported language to its available contexts.

8
_api-reference/script-apis/get-stored-script.md
View File

@ -11,13 +11,13 @@ Retrieves a stored script.
### Path parameters
| Parameter | Data Type | Description |
| Parameter | Data type | Description |
:--- | :--- | :---
| script | String | Stored script or search template name. Required.|
### Query parameters
| Parameter | Data Type | Description |
| Parameter | Data type | Description |
:--- | :--- | :---
| cluster_manager_timeout | Time | Amount of time to wait for a connection to the cluster manager. Optional, defaults to `30s`. |
@ -54,7 +54,7 @@ The `GET _scripts/my-first-script` request returns the following fields:
The `GET _scripts/my-first-script` request returns the following response fields:
| Field | Data Type | Description |
| Field | Data type | Description |
:--- | :--- | :---
| _id | String | The script's name. |
| found | Boolean | The requested script exists and was retrieved. |
@ -62,7 +62,7 @@ The `GET _scripts/my-first-script` request returns the following response fields
#### Script object
| Field | Data Type | Description |
| Field | Data type | Description |
:--- | :--- | :---
| lang | String | The script's language. |
| source | String | The script's body. |

2
_api-reference/snapshots/create-repository.md
View File

@ -17,7 +17,7 @@ To learn more about repositories, see [Register repository]({{site.url}}{{site.b
### Path parameters
Parameter | Data Type | Description
Parameter | Data type | Description
:--- | :--- | :---
repository | String | Repostory name. |

8
_api-reference/snapshots/create-snapshot.md
View File

@ -22,14 +22,14 @@ POST /_snapshot/<repository>/<snapshot>
### Path parameters
Parameter | Data Type | Description
Parameter | Data type | Description
:--- | :--- | :---
repository | String | Repostory name to contain the snapshot. |
snapshot | String | Name of Snapshot to create. |
### Query parameters
Parameter | Data Type | Description
Parameter | Data type | Description
:--- | :--- | :---
wait_for_completion | Boolean | Whether to wait for snapshot creation to complete before continuing. If you include this parameter, the snapshot definition is returned after completion. |
@ -37,7 +37,7 @@ wait_for_completion | Boolean | Whether to wait for snapshot creation to comple
The request body is optional.
Field | Data Type | Description
Field | Data type | Description
:--- | :--- | :---
`indices` | String | The indices you want to include in the snapshot. You can use `,` to create a list of indices, `*` to specify an index pattern, and `-` to exclude certain indices. Don't put spaces between items. Default is all indices.
`ignore_unavailable` | Boolean | If an index from the `indices` list doesn't exist, whether to ignore it rather than fail the snapshot. Default is false.
@ -122,7 +122,7 @@ The snapshot definition is returned.
```
#### Response fields
| Field | Data Type | Description |
| Field | Data type | Description |
| :--- | :--- | :--- |
| snapshot | string | Snapshot name. |
| uuid | string | Snapshot's universally unique identifier (UUID). |

2
_api-reference/snapshots/delete-snapshot-repository.md
View File

@ -15,7 +15,7 @@ nav_order: 3
### Path parameters
Parameter | Data Type | Description
Parameter | Data type | Description
:--- | :--- | :---
repository | String | Repository to delete. |

2
_api-reference/snapshots/delete-snapshot.md
View File

@ -17,7 +17,7 @@ Deletes a snapshot from a repository.
### Path parameters
Parameter | Data Type | Description
Parameter | Data type | Description
:--- | :--- | :---
repository | String | Repostory that contains the snapshot. |
snapshot | String | Snapshot to delete. |

6
_api-reference/snapshots/get-snapshot-repository.md
View File

@ -16,13 +16,13 @@ You can also get details about a snapshot during and after snapshot creation. Se
### Path parameters
| Parameter | Data Type | Description |
| Parameter | Data type | Description |
| :--- | :--- | :--- |
| repository | String | A comma-separated list of snapshot repository names to retrieve. Wildcard (`*`) expressions are supported including combining wildcards with exclude patterns starting with `-`. |
### Query parameters
| Parameter | Data Type | Description |
| Parameter | Data type | Description |
:--- | :--- | :---
| local | Boolean | Whether to get information from the local node. Optional, defaults to `false`.|
| cluster_manager_timeout | Time | Amount of time to wait for a connection to the master node. Optional, defaults to 30 seconds. |
@ -53,7 +53,7 @@ Upon success, the response returns repositry information. This sample is for an
### Response fields
| Field | Data Type | Description |
| Field | Data type | Description |
| :--- | :--- | :--- |
| type | string | Bucket type: `fs` (file system) or `s3` (s3 bucket) |
| bucket | string | S3 bucket name. |

6
_api-reference/snapshots/get-snapshot-status.md
View File

@ -18,7 +18,7 @@ If you use the security plugin, you must have the `monitor_snapshot`, `create_sn
Path parameters are optional.
| Parameter | Data Type | Description |
| Parameter | Data type | Description |
:--- | :--- | :---
| repository | String | Repository containing the snapshot. |
| snapshot | String | Snapshot to return. |
@ -36,7 +36,7 @@ Using the API to return state for other than currently running snapshots can be
### Request fields
| Field | Data Type | Description |
| Field | Data type | Description |
:--- | :--- | :---
| ignore_unavailable | Boolean | How to handles requests for unavailable snapshots. If `false`, the request returns an error for unavailable snapshots. If `true`, the request ignores unavailable snapshots, such as those that are corrupted or temporarily cannot be returned. Defaults to `false`.|
@ -368,7 +368,7 @@ The `GET _snapshot/my-opensearch-repo/my-first-snapshot/_status` request returns
### Response fields
| Field | Data Type | Description |
| Field | Data type | Description |
:--- | :--- | :---
| repository | String | Name of repository that contains the snapshot. |
| snapshot | String | Snapshot name. |

6
_api-reference/snapshots/get-snapshot.md
View File

@ -11,14 +11,14 @@ Retrieves information about a snapshot.
### Path parameters
| Parameter | Data Type | Description |
| Parameter | Data type | Description |
| :--- | :--- | :--- |
| repository | String | The repository that contains the snapshot to retrieve. |
| snapshot | String | Snapshot to retrieve.
### Query parameters
| Parameter | Data Type | Description |
| Parameter | Data type | Description |
:--- | :--- | :---
| verbose | Boolean | Whether to show all, or just basic snapshot information. If `true`, returns all information. If `false`, omits information like start/end times, failures, and shards. Optional, defaults to `true`.|
| ignore_unavailable | Boolean | How to handle snapshots that are unavailable (corrupted or otherwise temporarily can't be returned). If `true` and the snapshot is unavailable, the request does not return the snapshot. If `false` and the snapshot is unavailable, the request returns an error. Optional, defaults to `false`.|
@ -72,7 +72,7 @@ Upon success, the response returns snapshot information:
````
### Response fields
| Field | Data Type | Description |
| Field | Data type | Description |
| :--- | :--- | :--- |
| snapshot | string | Snapshot name. |
| uuid | string | Snapshot's universally unique identifier (UUID). |

8
_api-reference/snapshots/restore-snapshot.md
View File

@ -18,14 +18,14 @@ If open indices with the same name that you want to restore already exist in the
{: .note}
### Path parameters
| Parameter | Data Type | Description |
| Parameter | Data type | Description |
:--- | :--- | :---
repository | String | Repository containing the snapshot to restore. |
| snapshot | String | Snapshot to restore. |
### Query parameters
Parameter | Data Type | Description
Parameter | Data type | Description
:--- | :--- | :---
wait_for_completion | Boolean | Whether to wait for snapshot restoration to complete before continuing. |
@ -33,7 +33,7 @@ wait_for_completion | Boolean | Whether to wait for snapshot restoration to com
All request body parameters are optional.
| Parameter | Data Type | Description |
| Parameter | Data type | Description |
:--- | :--- | :---
| ignore_unavailable | Boolean | How to handle data streams or indices that are missing or closed. If `false`, the request returns an error for any data stream or index that is missing or closed. If `true`, the request ignores data streams and indices in indices that are missing or closed. Defaults to `false`. |
| ignore_index_settings | Boolean | A comma-delimited list of index settings that you don't want to restore from a snapshot. |
@ -90,7 +90,7 @@ Except for the snapshot name, all properties are empty or `0`. This is because a
### Response fields
| Field | Data Type | Description |
| Field | Data type | Description |
| :--- | :--- | :--- |
| snapshot | string | Snapshot name. |
| indices | array | Indices in the snapshot. |

6
_api-reference/snapshots/verify-snapshot-repository.md
View File

@ -19,13 +19,13 @@ If you use the security plugin, you must have the `manage cluster` privilege.
Path parameters are optional.
| Parameter | Data Type | Description |
| Parameter | Data type | Description |
:--- | :--- | :---
| repository | String | Name of repository to verify. |
### Query parameters
| Parameter | Data Type | Description |
| Parameter | Data type | Description |
:--- | :--- | :---
| cluster_manager_timeout | Time | Amount of time to wait for a connection to the master node. Optional, defaults to `30s`. |
| timeout | Time | The period of time to wait for a response. If a response is not received before the timeout value, the request fails and returns an error. Defaults to `30s`. |
@ -70,6 +70,6 @@ In the preceding sample, one node is connected to the snapshot repository. If mo
### Response fields
| Field | Data Type | Description |
| Field | Data type | Description |
:--- | :--- | :---
| nodes | Object | A list (not an array) of nodes connected to the snapshot repository. Each node itself is a property where the node ID is the key and the name has an ID (Object) and a name (String). |

2
_clients/javascript/helpers.md
View File

@ -53,7 +53,7 @@ Bulk helper operations return an object with the following fields:
When creating a new bulk helper instance, you can use the following configuration options.
| Option | Data Type | Required/Default | Description
| Option | Data type | Required/Default | Description
| :--- | :--- | :--- | :---
| `datasource` | An array, async generator or a readable stream of strings or objects | Required | Represents the documents you need to create, delete, index, or update.
| `onDocument` | Function | Required | A function to be invoked with each document in the given `datasource`. It returns the operation to be executed for this document. Optionally, the document can be manipulated for `create` and `index` operations by returning a new document as part of the function's result.

6
_ml-commons-plugin/api.md
View File

@ -127,7 +127,7 @@ POST /_plugins/_ml/models/_upload
All request fields are required.
Field | Data Type | Description
Field | Data type | Description
:--- | :--- | :---
`name`| string | The name of the model. |
`version` | integer | The version number of the model. |
@ -427,7 +427,7 @@ GET /_plugins/_ml/profile/tasks
### Path parameters
Parameter | Data Type | Description
Parameter | Data type | Description
:--- | :--- | :---
model_id | string | Returns runtime data for a specific model. You can string together multiple `model_id`s to return multiple model profiles.
tasks | string | Returns runtime data for a specific task. You can string together multiple `task_id`s to return multiple task profiles.
@ -436,7 +436,7 @@ tasks | string | Returns runtime data for a specific task. You can string togeth
All profile body request fields are optional.
Field | Data Type | Description
Field | Data type | Description
:--- | :--- | :---
node_ids | string | Returns all tasks and profiles from a specific node.
model_ids | string | Returns runtime data for a specific model. You can string together multiple `model_id`s to return multiple model profiles.

4
_ml-commons-plugin/model-serving-framework.md
View File

@ -45,7 +45,7 @@ POST /_plugins/_ml/models/_upload
The URL upload method requires the following request fields.
Field | Data Type | Description
Field | Data type | Description
:--- | :--- | :---
`name`| string | The name of the model. |
`version` | string | The version number of the model. Since OpenSearch does not enforce a specific version schema for models, you can choose any number or format that makes sense for your models. |
@ -55,7 +55,7 @@ Field | Data Type | Description
### The `model_config` object
| Field | Data Type | Description |
| Field | Data type | Description |
| :--- | :--- | :--- |
| `model_type` | string | The model type, such as `bert`. For a Huggingface model, the model type is specified in `config.json`. For an example, see the [`all-MiniLM-L6-v2` Huggingface model `config.json`](https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2/blob/main/config.json#L15).|
| `embedding_dimension` | integer | The dimension of the model-generated dense vector. For a Huggingface model, the dimension is specified in the model card. For example, in the [`all-MiniLM-L6-v2` Huggingface model card](https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2), the statement `384 dimensional dense vector space` specifies 384 as the embedding dimension. |

8
_monitoring-plugins/alerting/monitors.md
View File

@ -331,7 +331,7 @@ Below are some variables you can include in your message using Mustache template
#### Monitor variables
Variable | Data Type | Description
Variable | Data type | Description
:--- | :--- | :---
`ctx.monitor` | Object | Includes `ctx.monitor.name`, `ctx.monitor.type`, `ctx.monitor.enabled`, `ctx.monitor.enabled_time`, `ctx.monitor.schedule`, `ctx.monitor.inputs`, `triggers` and `ctx.monitor.last_update_time`.
`ctx.monitor.user` | Object | Includes information about the user who created the monitor. Includes `ctx.monitor.user.backend_roles` and `ctx.monitor.user.roles`, which are arrays that contain the backend roles and roles assigned to the user. See [alerting security]({{site.url}}{{site.baseurl}}/monitoring-plugins/alerting/security/) for more information.
@ -346,7 +346,7 @@ Variable | Data Type | Description
#### Trigger variables
Variable | Data Type | Description
Variable | Data type | Description
:--- | :--- | : ---
`ctx.trigger.id` | String | The trigger's ID.
`ctx.trigger.name` | String | The trigger's name.
@ -358,7 +358,7 @@ Variable | Data Type | Description
#### Action variables
Variable | Data Type | Description
Variable | Data type | Description
:--- | :--- | : ---
`ctx.trigger.actions.id` | String | The action's ID.
`ctx.trigger.actions.name` | String | The action's name.
@ -370,7 +370,7 @@ Variable | Data Type | Description
#### Other variables
Variable | Data Type | Description
Variable | Data type | Description
:--- | :--- : :---
`ctx.results` | Array | An array with one element (i.e. `ctx.results[0]`). Contains the query results. This variable is empty if the trigger was unable to retrieve results. See `ctx.error`.
`ctx.last_update_time` | Milliseconds | Unix epoch time of when the monitor was last updated.

4
_neural-search-plugin/index.md
View File

@ -31,7 +31,7 @@ Use `pipeline_name` to create a name for your Neural Search pipeline.
### Request fields
Field | Data Type | Description
Field | Data type | Description
:--- | :--- | :---
description | string | A description of the processor.
model_id | string | The ID of the model that will be used in the embedding interface. The model must be indexed in OpenSearch before it can be used in Neural Search. For more information, see [Model Serving Framework]
@ -138,7 +138,7 @@ If you want to use a language model to convert a text query into a k-NN vector q
Include the following request fields under the `neural` field in your query:
Field | Data Type | Description
Field | Data type | Description
:--- | :--- | :---
vector_field | string | The vector field against which to run a search query.
query_text | string | The query text from which to produce queries.

2
_notifications-plugin/api.md
View File

@ -156,7 +156,7 @@ POST /_plugins/_notifications/configs/
The create channel API operation accepts the following fields in its request body:
Field | Data Type | Description | Required
Field | Data type | Description | Required
:--- | :--- | :--- | :---
config_id | String | The configuration's custom ID. | No
config | Object | Contains all relevant information, such as channel name, configuration type, and plugin source. | Yes

2
_opensearch/geohexgrid-agg.md
View File

@ -368,7 +368,7 @@ The `bounds` parameter can be used with or without the `geo_bounding_box` filter
GeoHex grid aggregation requests support the following parameters.
Parameter | Data Type | Description
Parameter | Data type | Description
:--- | :--- | :---
field | String | The field that contains the geopoints. This field must be mapped as a `geo_point` field. If the field contains an array, all array values are aggregated. Required.
precision | Integer | The zoom level used to determine grid cells for bucketing results. Valid values are in the [0, 15] range. Optional. Default is 5.

16
_opensearch/point-in-time-api.md
View File

@ -32,13 +32,13 @@ POST /<target_indexes>/_search/point_in_time?keep_alive=1h&routing=&expand_wildc
### Path parameters
Parameter | Data Type | Description
Parameter | Data type | Description
:--- | :--- | :---
target_indexes | String | The name(s) of the target index(es) for the PIT. May contain a comma-separated list or a wildcard index pattern.
### Query parameters
Parameter | Data Type | Description
Parameter | Data type | Description
:--- | :--- | :---
keep_alive | Time | The amount of time to keep the PIT. Required.
preference | String | The node or the shard used to perform the search. Optional. Default is random.
@ -69,7 +69,7 @@ POST /my-index-1/_search/point_in_time?keep_alive=100m
### Response fields
Field | Data Type | Description
Field | Data type | Description
:--- | :--- | :---
pit_id | [Base64 encoded binary]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/binary) | The PIT ID.
creation_time | long | The time the PIT was created, in milliseconds since the epoch.
@ -141,13 +141,13 @@ GET /_search/point_in_time/_all
### Response fields
Field | Data Type | Description
Field | Data type | Description
:--- | :--- | :---
pits | Array of JSON objects | The list of all PITs.
Each PIT object contains the following fields.
Field | Data Type | Description
Field | Data type | Description
:--- | :--- | :---
pit_id | [Base64 encoded binary]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/binary) | The PIT ID.
creation_time | long | The time the PIT was created, in milliseconds since the epoch.
@ -175,7 +175,7 @@ If you want to delete one or several PITs, specify their PIT IDs in the request
### Request fields
Field | Data Type | Description
Field | Data type | Description
:--- | :--- | :---
pit_id | [Base64 encoded binary]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/binary) or an array of binaries | The PIT IDs of the PITs to be deleted. Required.
@ -213,7 +213,7 @@ For each PIT, the response contains a JSON object with a PIT ID and a `successfu
### Response fields
Field | Data Type | Description
Field | Data type | Description
:--- | :--- | :---
successful | Boolean | Whether the delete operation was successful.
pit_id | [Base64 encoded binary]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/binary) | The PIT ID of the PIT to be deleted.
@ -234,7 +234,7 @@ If you want to list segments for one or several PITs, specify their PIT IDs in t
### Request fields
Field | Data Type | Description
Field | Data type | Description
:--- | :--- | :---
pit_id | [Base64 encoded binary]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/binary) or an array of binaries | The PIT IDs of the PITs whose segments are to be listed. Required.

972
_opensearch/rest-api/nodes-apis/nodes-stats.md Normal file
View File

@ -0,0 +1,972 @@
---
layout: default
title: Nodes stats
parent: Nodes APIs
grand_parent: REST API reference
nav_order: 20
---
# Nodes stats
The nodes stats API returns statistics about your cluster.
## Path and HTTP methods
```json
GET /_nodes/stats
GET /_nodes/<node_id>/stats
GET /_nodes/stats/<metric>
GET /_nodes/<node_id>/stats/<metric>
GET /_nodes/stats/<metric>/<index_metric>
GET /_nodes/<node_id>/stats/<metric>/<index_metric>
```
## Path parameters
The following table lists the available path parameters. All path parameters are optional.
Parameter | Type | Description
:--- | :--- | :---
nodeId | String | A comma-separated list of nodeIds used to filter results. Supports [node filters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/nodes-apis/index/#node-filters). Defaults to `_all`.
metric | String | A comma-separated list of metric groups that will be included in the response. For example, `jvm,fs`. See the list of all metrics below. Defaults to all metrics.
index_metric | String | A comma-separated list of index metric groups that will be included in the response. For example, `docs,store`. See the list of all index metrics below. Defaults to all index metrics.
The following table lists all available metric groups.
Metric | Description
:--- |:----
indices | Index statistics, such as size, document count, and search, index, and delete times for documents.
os | Statistics about the host OS, including load, memory, and swapping.
process | Statistics about processes, including their memory consumption, open file descriptors, and CPU usage.
jvm | Statistics about the JVM, including memory pool, buffer pool, and garbage collection, and the number of loaded classes.
fs | File system statistics, such as read/write statistics, data path, and free disk space.
transport | Transport layer statistics about send/receive in cluster communication.
http | Statistics about the HTTP layer.
breaker | Statistics about the field data circuit breakers.
script | Statistics about scripts, such as compilations and cache evictions.
discovery | Statistics about cluster states.
ingest | Statistics about ingest pipelines.
adaptive_selection | Statistics about adaptive replica selection, which selects an eligible node using shard allocation awareness.
script_cache | Statistics about script cache.
indexing_pressure | Statistics about the node's indexing pressure.
shard_indexing_pressure | Statistics about shard indexing pressure.
To filter the information returned for the `indices` metric, you can use specific `index_metric` values. You can use these only when you use the following query types:
```json
GET _nodes/stats/
GET _nodes/stats/_all
GET _nodes/stats/indices
```
The following index metrics are supported:
- docs
- store
- indexing
- get
- search
- merge
- refresh
- flush
- warmer
- query_cache
- fielddata
- completion
- segments
- translog
- request_cache
For example, the following query requests statistics for `docs` and `search`:
```json
GET _nodes/stats/indices/docs,search
```
## Query parameters
The following table lists the available query parameters. All query parameters are optional.
Parameter | Type | Description
:--- | :--- | :---
completion_fields | String | The fields to include in completion statistics. Supports comma-separated lists and wildcard expressions.
fielddata_fields | String | The fields to include in fielddata statistics. Supports comma-separated lists and wildcard expressions.
fields | String | The fields to include. Supports comma-separated lists and wildcard expressions.
groups | String | A comma-separated list of search groups to include in the search statistics.
level | String | Specifies whether statistics are aggregated at the cluster, index, or shard level. Valid values are `indices`, `node`, and `shard`.
timeout | Time | Sets the time limit for node response. Default is `30s`.
include_segment_file_sizes | Boolean | If segment statistics are requested, this field specifies to return the aggregated disk usage of every Lucene index file. Default is `false`.
#### Sample request
```json
GET _nodes/stats/
```
#### Sample response
```json
{
"_nodes" : {
"total" : 1,
"successful" : 1,
"failed" : 0
},
"cluster_name" : "docker-cluster",
"nodes" : {
"F-ByTQzVQ3GQeYzQJArJGQ" : {
"timestamp" : 1664484195257,
"name" : "opensearch",
"transport_address" : "127.0.0.1:9300",
"host" : "127.0.0.1",
"ip" : "127.0.0.1:9300",
"roles" : [
"master",
"data",
"ingest",
"remote_cluster_client"
],
"attributes" : {
"shard_indexing_pressure_enabled" : "true"
},
"indices" : {
"docs" : {
"count" : 13160,
"deleted" : 12
},
"store" : {
"size_in_bytes" : 6263461,
"reserved_in_bytes" : 0
},
"indexing" : {
"index_total" : 0,
"index_time_in_millis" : 0,
"index_current" : 0,
"index_failed" : 0,
"delete_total" : 204,
"delete_time_in_millis" : 427,
"delete_current" : 0,
"noop_update_total" : 0,
"is_throttled" : false,
"throttle_time_in_millis" : 0
},
"get" : {
"total" : 4,
"time_in_millis" : 18,
"exists_total" : 4,
"exists_time_in_millis" : 18,
"missing_total" : 0,
"missing_time_in_millis" : 0,
"current" : 0
},
"search" : {
"open_contexts" : 0,
"query_total" : 194,
"query_time_in_millis" : 467,
"query_current" : 0,
"fetch_total" : 194,
"fetch_time_in_millis" : 143,
"fetch_current" : 0,
"scroll_total" : 0,
"scroll_time_in_millis" : 0,
"scroll_current" : 0,
"suggest_total" : 0,
"suggest_time_in_millis" : 0,
"suggest_current" : 0
},
"merges" : {
"current" : 0,
"current_docs" : 0,
"current_size_in_bytes" : 0,
"total" : 1,
"total_time_in_millis" : 5,
"total_docs" : 12,
"total_size_in_bytes" : 3967,
"total_stopped_time_in_millis" : 0,
"total_throttled_time_in_millis" : 0,
"total_auto_throttle_in_bytes" : 251658240
},
"refresh" : {
"total" : 74,
"total_time_in_millis" : 201,
"external_total" : 57,
"external_total_time_in_millis" : 314,
"listeners" : 0
},
"flush" : {
"total" : 28,
"periodic" : 28,
"total_time_in_millis" : 1261
},
"warmer" : {
"current" : 0,
"total" : 45,
"total_time_in_millis" : 99
},
"query_cache" : {
"memory_size_in_bytes" : 0,
"total_count" : 0,
"hit_count" : 0,
"miss_count" : 0,
"cache_size" : 0,
"cache_count" : 0,
"evictions" : 0
},
"fielddata" : {
"memory_size_in_bytes" : 356,
"evictions" : 0
},
"completion" : {
"size_in_bytes" : 0,
"fields" : { }
},
"segments" : {
"count" : 17,
"memory_in_bytes" : 0,
"terms_memory_in_bytes" : 0,
"stored_fields_memory_in_bytes" : 0,
"term_vectors_memory_in_bytes" : 0,
"norms_memory_in_bytes" : 0,
"points_memory_in_bytes" : 0,
"doc_values_memory_in_bytes" : 0,
"index_writer_memory_in_bytes" : 0,
"version_map_memory_in_bytes" : 0,
"fixed_bit_set_memory_in_bytes" : 288,
"max_unsafe_auto_id_timestamp" : -1,
"file_sizes" : { }
},
"translog" : {
"operations" : 12,
"size_in_bytes" : 1452,
"uncommitted_operations" : 12,
"uncommitted_size_in_bytes" : 1452,
"earliest_last_modified_age" : 164160
},
"request_cache" : {
"memory_size_in_bytes" : 1649,
"evictions" : 0,
"hit_count" : 0,
"miss_count" : 18
},
"recovery" : {
"current_as_source" : 0,
"current_as_target" : 0,
"throttle_time_in_millis" : 0
}
},
"os" : {
"timestamp" : 1664484195263,
"cpu" : {
"percent" : 0,
"load_average" : {
"1m" : 0.0,
"5m" : 0.0,
"15m" : 0.0
}
},
"mem" : {
"total_in_bytes" : 13137076224,
"free_in_bytes" : 9265442816,
"used_in_bytes" : 3871633408,
"free_percent" : 71,
"used_percent" : 29
},
"swap" : {
"total_in_bytes" : 4294967296,
"free_in_bytes" : 4294967296,
"used_in_bytes" : 0
},
"cgroup" : {
"cpuacct" : {
"control_group" : "/",
"usage_nanos" : 338710071600
},
"cpu" : {
"control_group" : "/",
"cfs_period_micros" : 100000,
"cfs_quota_micros" : -1,
"stat" : {
"number_of_elapsed_periods" : 0,
"number_of_times_throttled" : 0,
"time_throttled_nanos" : 0
}
},
"memory" : {
"control_group" : "/",
"limit_in_bytes" : "9223372036854771712",
"usage_in_bytes" : "1432346624"
}
}
},
"process" : {
"timestamp" : 1664484195263,
"open_file_descriptors" : 556,
"max_file_descriptors" : 65536,
"cpu" : {
"percent" : 0,
"total_in_millis" : 170870
},
"mem" : {
"total_virtual_in_bytes" : 6563344384
}
},
"jvm" : {
"timestamp" : 1664484195264,
"uptime_in_millis" : 21232111,
"mem" : {
"heap_used_in_bytes" : 308650480,
"heap_used_percent" : 57,
"heap_committed_in_bytes" : 536870912,
"heap_max_in_bytes" : 536870912,
"non_heap_used_in_bytes" : 147657128,
"non_heap_committed_in_bytes" : 152502272,
"pools" : {
"young" : {
"used_in_bytes" : 223346688,
"max_in_bytes" : 0,
"peak_used_in_bytes" : 318767104,
"peak_max_in_bytes" : 0,
"last_gc_stats" : {
"used_in_bytes" : 0,
"max_in_bytes" : 0,
"usage_percent" : -1
}
},
"old" : {
"used_in_bytes" : 67068928,
"max_in_bytes" : 536870912,
"peak_used_in_bytes" : 67068928,
"peak_max_in_bytes" : 536870912,
"last_gc_stats" : {
"used_in_bytes" : 34655744,
"max_in_bytes" : 536870912,
"usage_percent" : 6
}
},
"survivor" : {
"used_in_bytes" : 18234864,
"max_in_bytes" : 0,
"peak_used_in_bytes" : 32721280,
"peak_max_in_bytes" : 0,
"last_gc_stats" : {
"used_in_bytes" : 18234864,
"max_in_bytes" : 0,
"usage_percent" : -1
}
}
}
},
"threads" : {
"count" : 80,
"peak_count" : 80
},
"gc" : {
"collectors" : {
"young" : {
"collection_count" : 18,
"collection_time_in_millis" : 199
},
"old" : {
"collection_count" : 0,
"collection_time_in_millis" : 0
}
}
},
"buffer_pools" : {
"mapped" : {
"count" : 23,
"used_in_bytes" : 6232113,
"total_capacity_in_bytes" : 6232113
},
"direct" : {
"count" : 63,
"used_in_bytes" : 9050069,
"total_capacity_in_bytes" : 9050068
},
"mapped - 'non-volatile memory'" : {
"count" : 0,
"used_in_bytes" : 0,
"total_capacity_in_bytes" : 0
}
},
"classes" : {
"current_loaded_count" : 20693,
"total_loaded_count" : 20693,
"total_unloaded_count" : 0
}
},
"thread_pool" : {
"OPENSEARCH_ML_TASK_THREAD_POOL" : {
"threads" : 0,
"queue" : 0,
"active" : 0,
"rejected" : 0,
"largest" : 0,
"completed" : 0
},
"ad-batch-task-threadpool" : {
"threads" : 0,
"queue" : 0,
"active" : 0,
"rejected" : 0,
"largest" : 0,
"completed" : 0
},
...
},
"fs" : {
"timestamp" : 1664484195264,
"total" : {
"total_in_bytes" : 269490393088,
"free_in_bytes" : 261251477504,
"available_in_bytes" : 247490805760
},
"data" : [
{
"path" : "/usr/share/opensearch/data/nodes/0",
"mount" : "/ (overlay)",
"type" : "overlay",
"total_in_bytes" : 269490393088,
"free_in_bytes" : 261251477504,
"available_in_bytes" : 247490805760
}
],
"io_stats" : { }
},
"transport" : {
"server_open" : 0,
"total_outbound_connections" : 0,
"rx_count" : 0,
"rx_size_in_bytes" : 0,
"tx_count" : 0,
"tx_size_in_bytes" : 0
},
"http" : {
"current_open" : 5,
"total_opened" : 1108
},
"breakers" : {
"request" : {
"limit_size_in_bytes" : 322122547,
"limit_size" : "307.1mb",
"estimated_size_in_bytes" : 0,
"estimated_size" : "0b",
"overhead" : 1.0,
"tripped" : 0
},
"fielddata" : {
"limit_size_in_bytes" : 214748364,
"limit_size" : "204.7mb",
"estimated_size_in_bytes" : 356,
"estimated_size" : "356b",
"overhead" : 1.03,
"tripped" : 0
},
"in_flight_requests" : {
"limit_size_in_bytes" : 536870912,
"limit_size" : "512mb",
"estimated_size_in_bytes" : 0,
"estimated_size" : "0b",
"overhead" : 2.0,
"tripped" : 0
},
"parent" : {
"limit_size_in_bytes" : 510027366,
"limit_size" : "486.3mb",
"estimated_size_in_bytes" : 308650480,
"estimated_size" : "294.3mb",
"overhead" : 1.0,
"tripped" : 0
}
},
"script" : {
"compilations" : 0,
"cache_evictions" : 0,
"compilation_limit_triggered" : 0
},
"discovery" : {
"cluster_state_queue" : {
"total" : 0,
"pending" : 0,
"committed" : 0
},
"published_cluster_states" : {
"full_states" : 2,
"incompatible_diffs" : 0,
"compatible_diffs" : 10
}
},
"ingest" : {
"total" : {
"count" : 0,
"time_in_millis" : 0,
"current" : 0,
"failed" : 0
},
"pipelines" : { }
},
"adaptive_selection" : {
"F-ByTQzVQ3GQeYzQJArJGQ" : {
"outgoing_searches" : 0,
"avg_queue_size" : 0,
"avg_service_time_ns" : 501024,
"avg_response_time_ns" : 794105,
"rank" : "0.8"
}
},
"script_cache" : {
"sum" : {
"compilations" : 0,
"cache_evictions" : 0,
"compilation_limit_triggered" : 0
},
"contexts" : [
{
"context" : "aggregation_selector",
"compilations" : 0,
"cache_evictions" : 0,
"compilation_limit_triggered" : 0
},
{
"context" : "aggs",
"compilations" : 0,
"cache_evictions" : 0,
"compilation_limit_triggered" : 0
},
...
]
},
"indexing_pressure" : {
"memory" : {
"current" : {
"combined_coordinating_and_primary_in_bytes" : 0,
"coordinating_in_bytes" : 0,
"primary_in_bytes" : 0,
"replica_in_bytes" : 0,
"all_in_bytes" : 0
},
"total" : {
"combined_coordinating_and_primary_in_bytes" : 40256,
"coordinating_in_bytes" : 40256,
"primary_in_bytes" : 45016,
"replica_in_bytes" : 0,
"all_in_bytes" : 40256,
"coordinating_rejections" : 0,
"primary_rejections" : 0,
"replica_rejections" : 0
},
"limit_in_bytes" : 53687091
}
},
"shard_indexing_pressure" : {
"stats" : { },
"total_rejections_breakup_shadow_mode" : {
"node_limits" : 0,
"no_successful_request_limits" : 0,
"throughput_degradation_limits" : 0
},
"enabled" : false,
"enforced" : false
}
}
}
}
```
## Response fields
The following table lists all response fields.
| Field | Data type | Description |
| :--- | :--- | :--- |
| _nodes | Object | Statistics about the nodes that are returned. |
| _nodes.total | Integer | The total number of nodes for this request. |
| _nodes.successful | Integer | The number of nodes for which the request was successful. |
| _nodes.failed | Integer | The number of nodes for which the request failed. If there are nodes for which the request failed, the failure message is included. |
| cluster_name | String | The name of the cluster. |
| [nodes](#nodes) | Object | Statistics for the nodes included in this request. |
### `nodes`
The `nodes` object contains all nodes that are returned by the request, along with their IDs. Each node has the following properties.
Field | Data type | Description
:--- | :--- | :---
timestamp | Integer | The time the nodes statistics were collected, in milliseconds since the epoch.
name | String | The name of the node.
transport_address | IP address | The host and port of the transport layer that is used by nodes in a cluster to communicate internally.
host | IP address | The network host of the node.
ip | IP address | The IP address and port of the node.
roles | Array | The roles of the node (for example, `master`, `data`, or `ingest`).
attributes | Object | The attributes of the node (for example, `shard_indexing_pressure_enabled`).
[indices](#indices) | Object | Index statistics for each index that has shards on the node.
[os](#os) | Object | Statistics about the OS for the node.
[process](#process) | Object | Process statistics for the node.
[jvm](#jvm) | Object | Statistics about the JVM for the node.
[thread_pool](#thread_pool)| Object | Statistics about each thread pool for the node.
[fs](#fs) | Object | Statistics about the file stores for the node.
[transport](#transport) | Object | Transport statistics for the node.
http | Object | HTTP statistics for the node.
http.current_open | Integer | The number of currently open HTTP connections for the node.
http.total_opened | Integer | The total number of HTTP connections the node has opened since it started.
[breakers](#breakers) | Object | Statistics about the circuit breakers for the node.
[script](#script-and-script_cache)| Object | Script statistics for the node.
[script_cache](#script-and-script_cache)| Object | Script cache statistics for the node.
[discovery](#discovery) | Object | Node discovery statistics for the node.
[ingest](#ingest) | Object | Ingest statistics for the node.
[adaptive_selection](#adaptive_selection) | Object | Statistics about adaptive selections for the node.
[indexing_pressure](#indexing_pressure) | Object | Statistics related to the node's indexing pressure.
[shard_indexing_pressure](#shard_indexing_pressure) | Object | Statistics related to indexing pressure at the shard level.
### `indices`
The `indices` object contains the index statistics for each index with shards on this node. Each index has the following properties.
Field | Field type | Description
:--- | :--- | :---
docs | Object | Document statistics for all primary shards that exist on the node.
docs.<br>&nbsp;&nbsp;&nbsp;&nbsp;count | Integer | The number of documents reported by Lucene. Excludes deleted documents and recently indexed documents that are not yet assigned to a segment. Nested documents are counted separately.
docs.<br>&nbsp;&nbsp;&nbsp;&nbsp;deleted | Integer | The number of deleted documents reported by Lucene. Excludes recent deletion operations that have not yet affect the segment.
store | Object | Statistics about the shard sizes of the shards on the node.
store.<br>&nbsp;&nbsp;&nbsp;&nbsp;size_in_bytes | Integer | Total size of all shards on the node.
store.<br>&nbsp;&nbsp;&nbsp;&nbsp;reserved_in_bytes | Integer | The predicted number of bytes the shard store will grow to be because of activities such as restoring snapshots and peer recoveries.
indexing | Object | Statistics about indexing operations for the node.
indexing.<br>&nbsp;&nbsp;&nbsp;&nbsp;index_total | Integer | The total number of indexing operations on the node.
indexing.<br>&nbsp;&nbsp;&nbsp;&nbsp;index_time_in_millis | Integer | The total time for all indexing operations, in milliseconds.
indexing.<br>&nbsp;&nbsp;&nbsp;&nbsp;index_current | Integer | The number of indexing operations that are currently running.
indexing.<br>&nbsp;&nbsp;&nbsp;&nbsp;index_failed | Integer | The number of indexing operations that have failed.
indexing.<br>&nbsp;&nbsp;&nbsp;&nbsp;delete_total | Integer | The total number of deletions.
indexing.<br>&nbsp;&nbsp;&nbsp;&nbsp;delete_time_in_millis | Integer | The total time for all deletion operations, in milliseconds.
indexing.<br>&nbsp;&nbsp;&nbsp;&nbsp;delete_current | Integer | The number of deletion operations that are currently running.
indexing.<br>&nbsp;&nbsp;&nbsp;&nbsp;noop_update_total | Integer | The total number of noop operations.
indexing.<br>&nbsp;&nbsp;&nbsp;&nbsp;is_throttled | Boolean | Specifies whether any operations were throttled.
indexing.<br>&nbsp;&nbsp;&nbsp;&nbsp;throttle_time_in_millis | Integer | The total time for throttling operations, in milliseconds.
get | Object | Statistics about the get operations for the node.
get.<br>&nbsp;&nbsp;&nbsp;&nbsp;total | Integer | The total number of get operations.
get.<br>&nbsp;&nbsp;&nbsp;&nbsp;time_in_millis | Integer | The total time for all get operations, in milliseconds.
get.<br>&nbsp;&nbsp;&nbsp;&nbsp;exists_total | Integer | The total number of successful get operations.
get.<br>&nbsp;&nbsp;&nbsp;&nbsp;exists_time_in_millis | Integer | The total time for all successful get operations, in milliseconds.
get.<br>&nbsp;&nbsp;&nbsp;&nbsp;missing_total | Integer | The number of failed get operations.
get.<br>&nbsp;&nbsp;&nbsp;&nbsp;missing_time_in_millis | Integer | The total time for all failed get operations, in milliseconds.
get.<br>&nbsp;&nbsp;&nbsp;&nbsp;current | Integer | The number of get operations that are currently running.
search | Object | Statistics about the search operations for the node.
search.<br>&nbsp;&nbsp;&nbsp;&nbsp;open_contexts | Integer | The number of open search contexts.
search.<br>&nbsp;&nbsp;&nbsp;&nbsp;query_total | Integer | The total number of query operations.
search.<br>&nbsp;&nbsp;&nbsp;&nbsp;query_time_in_millis | Integer | The total time for all query operations, in milliseconds.
search.<br>&nbsp;&nbsp;&nbsp;&nbsp;query_current | Integer | The number of query operations that are currently running.
search.<br>&nbsp;&nbsp;&nbsp;&nbsp;fetch_total | Integer | The total number of fetch operations.
search.<br>&nbsp;&nbsp;&nbsp;&nbsp;fetch_time_in_millis | Integer | The total time for all fetch operations, in milliseconds.
search.<br>&nbsp;&nbsp;&nbsp;&nbsp;fetch_current | Integer | The number of fetch operations that are currently running.
search.<br>&nbsp;&nbsp;&nbsp;&nbsp;scroll_total | Integer | The total number of scroll operations.
search.<br>&nbsp;&nbsp;&nbsp;&nbsp;scroll_time_in_millis | Integer | The total time for all scroll operations, in milliseconds.
search.<br>&nbsp;&nbsp;&nbsp;&nbsp;scroll_current | Integer | The number of scroll operations that are currently running.
search.<br>&nbsp;&nbsp;&nbsp;&nbsp;suggest_total | Integer | The total number of suggest operations.
search.<br>&nbsp;&nbsp;&nbsp;&nbsp;suggest_time_in_millis | Integer | The total time for all suggest operations, in milliseconds.
search.<br>&nbsp;&nbsp;&nbsp;&nbsp;suggest_current | Integer | The number of suggest operations that are currently running.
merges | Object | Statistics about merge operations for the node.
merges.<br>&nbsp;&nbsp;&nbsp;&nbsp;current | Integer | The number of merge operations that are currently running.
merges.<br>&nbsp;&nbsp;&nbsp;&nbsp;current_docs | Integer | The number of document merges that are currently running.
merges.<br>&nbsp;&nbsp;&nbsp;&nbsp;current_size_in_bytes | Integer | The memory size, in bytes, that is used to perform current merge operations.
merges.<br>&nbsp;&nbsp;&nbsp;&nbsp;total | Integer | The total number of merge operations.
merges.<br>&nbsp;&nbsp;&nbsp;&nbsp;total_time_in_millis | Integer | The total time for merges, in milliseconds.
merges.<br>&nbsp;&nbsp;&nbsp;&nbsp;total_docs | Integer | The total number of documents that have been merged.
merges.<br>&nbsp;&nbsp;&nbsp;&nbsp;total_size_in_bytes | Integer | The total size of all merged documents, in bytes.
merges.<br>&nbsp;&nbsp;&nbsp;&nbsp;total_stopped_time_in_millis | Integer | The total time spent on stopping merge operations, in milliseconds.
merges.<br>&nbsp;&nbsp;&nbsp;&nbsp;total_throttled_time_in_millis | Integer | The total time spent on throttling merge operations, in milliseconds.
merges.<br>&nbsp;&nbsp;&nbsp;&nbsp;total_auto_throttle_in_bytes | Integer | The total size of automatically throttled merge operations, in bytes.
refresh | Object | Statistics about refresh operations for the node.
refresh.<br>&nbsp;&nbsp;&nbsp;&nbsp;total | Integer | The total number of refresh operations.
refresh.<br>&nbsp;&nbsp;&nbsp;&nbsp;total_time_in_millis | Integer | The total time for all refresh operations, in milliseconds.
refresh.<br>&nbsp;&nbsp;&nbsp;&nbsp;external_total | Integer | The total number of external refresh operations.
refresh.<br>&nbsp;&nbsp;&nbsp;&nbsp;external_total_time_in_millis | Integer | The total time for all external refresh operations, in milliseconds.
refresh.<br>&nbsp;&nbsp;&nbsp;&nbsp;listeners | Integer | The number of refresh listeners.
flush | Object | Statistics about flush operations for the node.
flush.<br>&nbsp;&nbsp;&nbsp;&nbsp;total | Integer | The total number of flush operations.
flush.<br>&nbsp;&nbsp;&nbsp;&nbsp;periodic | Integer | The total number of periodic flush operations.
flush.<br>&nbsp;&nbsp;&nbsp;&nbsp;total_time_in_millis | Integer | The total time for all flush operations, in milliseconds.
warmer | Object | Statistics about the index warming operations for the node.
warmer.<br>&nbsp;&nbsp;&nbsp;&nbsp;current | Integer | The number of current index warming operations.
warmer.<br>&nbsp;&nbsp;&nbsp;&nbsp;total | Integer | The total number of index warming operations.
warmer.<br>&nbsp;&nbsp;&nbsp;&nbsp;total_time_in_millis | Integer | The total time for all index warming operations, in milliseconds.
query_cache | Statistics about query cache operations for the node.
query_cache.<br>&nbsp;&nbsp;&nbsp;&nbsp;memory_size_in_bytes | Integer | The amount of memory used for the query cache for all shards in the node.
query_cache.<br>&nbsp;&nbsp;&nbsp;&nbsp;total_count | Integer | The total number of hits, misses, and cached queries in the query cache.
query_cache.<br>&nbsp;&nbsp;&nbsp;&nbsp;hit_count | Integer | The total number of hits in the query cache.
query_cache.<br>&nbsp;&nbsp;&nbsp;&nbsp;miss_count | Integer | The total number of misses in the query cache.
query_cache.<br>&nbsp;&nbsp;&nbsp;&nbsp;cache_size | Integer | The size of the query cache, in bytes.
query_cache.<br>&nbsp;&nbsp;&nbsp;&nbsp;cache_count | Integer | The number of queries in the query cache.
query_cache.<br>&nbsp;&nbsp;&nbsp;&nbsp;evictions | Integer | The number of evictions in the query cache.
fielddata | Object | Statistics about the field data cache for all shards in the node.
fielddata.<br>&nbsp;&nbsp;&nbsp;&nbsp;memory_size_in_bytes | Integer | The total amount of memory used for the field data cache for all shards in the node.
fielddata.<br>&nbsp;&nbsp;&nbsp;&nbsp;evictions | Integer | The number of evictions in the field data cache.
fielddata.<br>&nbsp;&nbsp;&nbsp;&nbsp;fields | Object | Contains all field data fields.
completion | Object | Statistics about completions for all shards in the node.
completion.<br>&nbsp;&nbsp;&nbsp;&nbsp;size_in_bytes | Integer | The total amount of memory used for completion for all shards in the node, in bytes.
completion.<br>&nbsp;&nbsp;&nbsp;&nbsp;fields | Object | Contains completion fields.
segments | Object | Statistics about segments for all shards in the node.
segments.<br>&nbsp;&nbsp;&nbsp;&nbsp;count | Integer | The total number of segments.
segments.<br>&nbsp;&nbsp;&nbsp;&nbsp;memory_in_bytes | Integer | The total amount of memory, in bytes.
segments.<br>&nbsp;&nbsp;&nbsp;&nbsp;terms_memory_in_bytes | Integer | The total amount of memory used for terms, in bytes.
segments.<br>&nbsp;&nbsp;&nbsp;&nbsp;stored_fields_memory_in_bytes | Integer | The total amount of memory used for stored fields, in bytes.
segments.<br>&nbsp;&nbsp;&nbsp;&nbsp;term_vectors_memory_in_bytes | Integer | The total amount of memory used for term vectors, in bytes.
segments.<br>&nbsp;&nbsp;&nbsp;&nbsp;norms_memory_in_bytes | Integer | The total amount of memory used for normalization factors, in bytes.
segments.<br>&nbsp;&nbsp;&nbsp;&nbsp;points_memory_in_bytes | Integer | The total amount of memory used for points, in bytes.
segments.<br>&nbsp;&nbsp;&nbsp;&nbsp;doc_values_memory_in_bytes | Integer | The total amount of memory used for doc values, in bytes.
segments.<br>&nbsp;&nbsp;&nbsp;&nbsp;index_writer_memory_in_bytes | Integer | The total amount of memory used by all index writers, in bytes.
segments.<br>&nbsp;&nbsp;&nbsp;&nbsp;version_map_memory_in_bytes | Integer | The total amount of memory used by all version maps, in bytes.
segments.<br>&nbsp;&nbsp;&nbsp;&nbsp;fixed_bit_set_memory_in_bytes | Integer | The total amount of memory used by fixed bit sets, in bytes. Fixed bit sets are used for nested objects and join fields.
segments.<br>&nbsp;&nbsp;&nbsp;&nbsp;max_unsafe_auto_id_timestamp | Integer | The timestamp for the most recently retired indexing request, in milliseconds since the epoch.
segments.<br>&nbsp;&nbsp;&nbsp;&nbsp;file_sizes | Integer | Statistics about the size of the segment files.
translog | Object | Statistics about transaction log operations for the node.
translog.<br>&nbsp;&nbsp;&nbsp;&nbsp;operations | Integer | The number of translog operations.
translog.<br>&nbsp;&nbsp;&nbsp;&nbsp;size_in_bytes | Integer | The size of the translog, in bytes.
translog.<br>&nbsp;&nbsp;&nbsp;&nbsp;uncommitted_operations | Integer | The number of uncommitted translog operations.
translog.<br>&nbsp;&nbsp;&nbsp;&nbsp;uncommitted_size_in_bytes | Integer | The size of uncommitted translog operations, in bytes.
translog.<br>&nbsp;&nbsp;&nbsp;&nbsp;earliest_last_modified_age | Integer | The earliest last modified age for the translog.
request_cache | Object | Statistics about the request cache for the node.
request_cache.<br>&nbsp;&nbsp;&nbsp;&nbsp;memory_size_in_bytes | Integer | The memory size used by the request cache, in bytes.
request_cache.<br>&nbsp;&nbsp;&nbsp;&nbsp;evictions | Integer | The number of request cache evictions.
request_cache.<br>&nbsp;&nbsp;&nbsp;&nbsp;hit_count | Integer | The number of request cache hits.
request_cache.<br>&nbsp;&nbsp;&nbsp;&nbsp;miss_count | Integer | The number of request cache misses.
recovery | Object | Statistics about recovery operations for the node.
recovery.<br>&nbsp;&nbsp;&nbsp;&nbsp;current_as_source | Integer | The number of recovery operations that have used an index shard as a source.
recovery.<br>&nbsp;&nbsp;&nbsp;&nbsp;current_as_target | Integer | The number of recovery operations that have used an index shard as a target.
recovery.<br>&nbsp;&nbsp;&nbsp;&nbsp;throttle_time_in_millis | Integer | The delay of recovery operations due to throttling, in milliseconds.
### `os`
The `os` object has the OS statistics for the node and has the following properties.
Field | Field type | Description
:--- | :--- | :---
timestamp | Integer | The last refresh time for the OS statistics, in milliseconds since the epoch.
cpu | Object | Statistics about the node's CPU usage.
cpu.percent | Integer | Recent CPU usage for the system.
cpu.load_average | Object | Statistics about load averages for the system.
cpu.load_average.1m | Float | The load average for the system for the time period of one minute.
cpu.load_average.5m | Float | The load average for the system for the time period of five minutes.
cpu.load_average.15m | Float | The load average for the system for the time period of 15 minutes.
cpu.mem | Object | Statistics about memory usage for the node.
cpu.mem.&nbsp;&nbsp;&nbsp;&nbsp;total_in_bytes | Integer | The total amount of physical memory, in bytes.
cpu.mem.&nbsp;&nbsp;&nbsp;&nbsp;free_in_bytes | Integer | The total amount of free physical memory, in bytes.
cpu.mem.&nbsp;&nbsp;&nbsp;&nbsp;used_in_bytes | Integer | The total amount of used physical memory, in bytes.
cpu.mem.&nbsp;&nbsp;&nbsp;&nbsp;free_percent | Integer | The percentage of memory that is free.
cpu.mem.&nbsp;&nbsp;&nbsp;&nbsp;used_percent | Integer | The percentage of memory that is used.
cpu.swap | Object | Statistics about swap space for the node.
cpu.swap.&nbsp;&nbsp;&nbsp;&nbsp;total_in_bytes | Integer | The total amount of swap space, in bytes.
cpu.swap.free_in_bytes | Integer | The total amount of free swap space, in bytes.
cpu.swap.&nbsp;&nbsp;&nbsp;&nbsp;used_in_bytes | Integer | The total amount of used swap space, in bytes.
cpu.cgroup | Object | Contains cgroup statistics for the node. Returned for Linux only.
cpu.cgroup.cpuacct | Object | Statistics about the cpuacct control group for the node.
cpu.cgroup.&nbsp;&nbsp;&nbsp;&nbsp;cpu | Object | Statistics about the CPU control group for the node.
cpu.cgroup.&nbsp;&nbsp;&nbsp;&nbsp;memory | Object | Statistics about the memory control group for the node.
### `process`
The `process` object contains process statistics for the node and has the following properties.
Field | Field type | Description
:--- | :--- | :---
timestamp | Integer | The last refresh time for the process statistics, in milliseconds since the epoch.
open_file_descriptors | Integer | The number of opened file descriptors associated with the current process.
max_file_descriptors | Integer | The maximum number of file descriptors for the system.
cpu | Object | Statistics about the CPU for the node.
cpu.percent | Integer | The percentage of CPU usage for the process.
cpu.total_in_millis | Integer | The total CPU time used by the process on which the JVM is running, in milliseconds.
mem | Object | Statistics about the memory for the node.
mem.total_virtual_in_bytes | Integer | The total amount of virtual memory that is guaranteed to be available to the process that is currently running, in bytes.
### `jvm`
The `jvm` object contains statistics about the JVM for the node and has the following properties.
Field | Field type | Description
:--- | :--- | :---
timestamp | Integer | The last refresh time for the JVM statistics, in milliseconds since the epoch.
uptime_in_millis | Integer | The JVM uptime, in milliseconds.
mem | Object | Statistics for the JVM memory usage on the node.
mem.heap_used_in_bytes | Integer | The amount of memory that is currently being used, in bytes.
mem.heap_used_percent | Integer | The percentage of memory that is currently used by the heap.
mem.heap_committed_in_bytes | Integer | The amount of memory available for use by the heap, in bytes.
mem.heap_max_in_bytes | Integer | The maximum amount of memory available for use by the heap, in bytes.
mem.non_heap_used_in_bytes | Integer | The amount of non-heap memory that is currently used, in bytes.
mem.non_heap_committed_in_bytes | Integer | The maximum amount of non-heap memory available for use, in bytes.
mem.pools | Object | Statistics about heap memory usage for the node.
mem.pools.young | Object | Statistics about the young generation heap memory usage for the node. Contains the amount of memory used, the maximum amount of memory available, and the peak amount of memory used.
mem.pools.old | Object | Statistics about the old generation heap memory usage for the node. Contains the amount of memory used, the maximum amount of memory available, and the peak amount of memory used.
mem.pools.survivor | Object | Statistics about the survivor space memory usage for the node. Contains the amount of memory used, the maximum amount of memory available, and the peak amount of memory used.
threads | Object | Statistics about the JVM thread usage for the node.
threads.count | Integer | The number of threads that are currently active in the JVM.
threads.peak_count | Integer | The maximum number of threads in the JVM.
gc.collectors | Object | Statistics about the JVM garbage collectors for the node.
gc.collectors.young | Integer | Statistics about JVM garbage collectors that collect young generation objects.
gc.collectors.young.collection_count | Integer | The number of garbage collectors that collect young generation objects.
gc.collectors.young.collection_time_in_millis | Integer | The total time spent on garbage collection of young generation objects, in milliseconds.
gc.collectors.old | Integer | Statistics about JVM garbage collectors that collect old generation objects.
gc.collectors.old.collection_count | Integer | The number of garbage collectors that collect old generation objects.
gc.collectors.old.collection_time_in_millis | Integer | The total time spent on garbage collection of old generation objects, in milliseconds.
buffer_pools | Object | Statistics about the JVM buffer pools for the node.
buffer_pools.mapped | Object | Statistics about the mapped JVM buffer pools for the node.
buffer_pools.mapped.count | Integer | The number of mapped buffer pools.
buffer_pools.mapped.used_in_bytes | Integer | The amount of memory used by mapped buffer pools, in bytes.
buffer_pools.mapped.total_capacity_in_bytes | Integer | The total capacity of the mapped buffer pools, in bytes.
buffer_pools.direct | Object | Statistics about the direct JVM buffer pools for the node.
buffer_pools.direct.count | Integer | The number of direct buffer pools.
buffer_pools.direct.used_in_bytes | Integer | The amount of memory used by direct buffer pools, in bytes.
buffer_pools.direct.total_capacity_in_bytes | Integer | The total capacity of the direct buffer pools, in bytes.
classes | Object | Statistics about the classes loaded by the JVM for the node.
classes.current_loaded_count | Integer | The number of classes currently loaded by the JVM.
classes.total_loaded_count | Integer | The total number of classes loaded by the JVM since it started.
classes.total_unloaded_count | Integer | The total number of classes unloaded by the JVM since it started.
### `thread_pool`
The `thread_pool` object contains a list of all thread pools. Each thread pool is a nested object specified by its ID with the properties listed below.
Field | Field type | Description
:--- | :--- | :---
threads | Integer | The number of threads in the pool.
queue | Integer | The number of threads in queue.
active | Integer | The number of active threads in the pool.
rejected | Integer | The number of tasks that have been rejected.
largest | Integer | The peak number of threads in the pool.
completed | Integer | The number of tasks completed.
### `fs`
The `fs` object represents statistics about the file stores for the node. It has the following properties.
Field | Field type | Description
:--- | :--- | :---
timestamp | Integer | The last refresh time for the file store statistics, in milliseconds since the epoch.
total | Object | Statistics for all file stores of the node.
total.total_in_bytes | Integer | The total memory size of all file stores, in bytes.
total.free_in_bytes | Integer | The total unallocated disk space in all file stores, in bytes.
total.available_in_bytes | Integer | The total disk space available to the JVM on all file stores. Represents the actual amount of memory, in bytes, that OpenSearch can use.
data | Array | The list of all file stores. Each file store has the properties listed below.
data.path | String | The path to the file store.
data.mount | String | The mount point of the file store.
data.type | String | The type of the file store (for example, overlay).
data.total_in_bytes | Integer | The total size of the file store, in bytes.
data.free_in_bytes | Integer | The total unallocated disk space in the file store, in bytes.
data.available_in_bytes | Integer | The total amount of disk space available to the JVM for the file store, in bytes.
io_stats | Object | I/O statistics for the node (Linux only). Includes devices, read and write operations, and the I/O operation time.
### `transport`
The `transport` object has the following properties.
Field | Field type | Description
:--- | :--- | :---
server_open | Integer | The number of open inbound TCP connections that OpenSearch nodes use for internal communication.
total_outbound_connections | Integer | The total number of outbound transport connections that the node has opened since it started.
rx_count | Integer | The total number of RX (receive) packets the node received during internal communication.
rx_size_in_bytes | Integer | The total size of RX packets the node received during internal communication, in bytes.
tx_count | Integer | The total number of TX (transmit) packets the node sent during internal communication.
tx_size_in_bytes | Integer | The total size of TX (transmit) packets the node sent during internal communication, in bytes.
### `breakers`
The `breakers` object contains statistics about the circuit breakers for the node. Each circuit breaker is a nested object listed by name and contains the following properties.
Field | Field type | Description
:--- | :--- | :---
limit_size_in_bytes | Integer | The memory limit for the circuit breaker, in bytes.
limit_size | Byte value | The memory limit for the circuit breaker in human-readable format (for example, `307.1mb`).
estimated_size_in_bytes | Integer | The estimated memory used for the operation, in bytes.
estimated_size | Byte value | The estimated memory used for the operation in human-readable format (for example, `356b`).
overhead | Float | A factor that all estimates are multiplied by to calculate the final estimate.
tripped | Integer | The total number of times the circuit breaker has been activated to prevent an out-of-memory error.
### `script` and `script_cache`
The `script` and `script_cache` objects have the following properties.
Field | Field type | Description
:--- | :--- | :---
script | Object | Script statistics for the node.
script.compilations | Integer | The total number of script compilations for the node.
script.cache_evictions| Integer | The total number of times the script cache has purged old data.
script.compilation_limit_triggered | Integer | The total number of times script compilation was limited by a circuit breaker.
script_cache | Object | Script cache statistics for the node.
script_cache.sum.compilations | Integer | The total number of script compilations in the cache for the node.
script_cache.sum.cache_evictions| Integer | The total number of times the script cache has purged old data.
script_cache.sum.compilation_limit_triggered | Integer | The total number of times script compilation in the cache was limited by a circuit breaker.
script_cache.contexts | Array of objects | The list of contexts for the script cache. Each context contains its name, the number of compilations, the number of cache evictions, and the number of times the script was limited by a circuit breaker.
### `discovery`
The `discovery` object contains the node discovery statistics and has the following properties.
Field | Field type | Description
:--- | :--- | :---
cluster_state_queue | Object | Cluster state queue statistics for the node.
cluster_state_queue.total | Integer | The total number of cluster states in the queue.
cluster_state_queue.pending | Integer | The number of pending cluster states in the queue.
cluster_state_queue.committed | Integer | The number of committed cluster states in the queue.
published_cluster_states | Object | Statistics for the published cluster states for the node.
published_cluster_states.full_states | Integer | The number of published cluster states.
published_cluster_states.incompatible_diffs | Integer | The number of incompatible differences between published cluster states.
published_cluster_states.compatible_diffs | Integer | The number of compatible differences between published cluster states.
### `ingest`
The `ingest` object contains the ingest statistics and has the following properties.
Field | Field type | Description
:--- | :--- | :---
total | Integer | Ingest statistics for the node's lifetime.
total.count | Integer | The total number of documents ingested by the node.
total.time_in_millis | Integer | The total amount of time for preprocessing ingest documents, in milliseconds.
total.current | Integer | The total number of documents that are currently being ingested by the node.
total.failed | Integer | The total number of failed ingestions for the node.
pipelines | Object | Ingest pipeline statistics for the node. Each pipeline is a nested object specified by its ID with the properties listed below.
pipelines._id_.count | Integer | The number of documents preprocessed by the ingest pipeline.
pipelines._id_.time_in_millis | Integer | The total amount of time for preprocessing documents in the ingest pipeline, in milliseconds.
pipelines._id_.failed | Integer | The total number of failed ingestions for the ingest pipeline.
pipelines._id_.processors | Array of objects | Statistics for the ingest processors. Includes the number of documents that are currently transformed, the total number of transformed documents, the number of failed transformations, and the time spent transforming documents.
### `adaptive_selection`
The `adaptive_selection` object contains the adaptive selection statistics. Each entry is specified by the node ID and has the properties listed below.
Field | Field type | Description
:--- | :--- | :---
outgoing_searches | Integer | The number of outgoing search requests for the node.
avg_queue_size | Integer | The rolling average queue size of search requests for the node (exponentially weighted).
avg_service_time_ns | Integer | The rolling average service time for search requests, in nanoseconds (exponentially weighted).
avg_response_time_ns | Integer | The rolling average response time for search requests, in nanoseconds (exponentially weighted).
rank | String | The node's rank that is used to select shards when routing requests.
### `indexing_pressure`
The `indexing_pressure` object contains the indexing pressure statistics and has the following properties.
Field | Field type | Description
:--- | :--- | :---
memory | Object | Statistics related to memory consumption for the indexing load.
memory.<br>&nbsp;&nbsp;&nbsp;&nbsp;current | Object | Statistics related to memory consumption for the current indexing load.
memory.<br>&nbsp;&nbsp;&nbsp;&nbsp;current.<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;combined_coordinating_and_primary_in_bytes | Integer | The total memory used by indexing requests in the coordinating or primary stages, in bytes. A node can reuse the coordinating memory if the primary stage is run locally, so the total memory does not necessarily equal the sum of the coordinating and primary stage memory usage.
memory.<br>&nbsp;&nbsp;&nbsp;&nbsp;current.<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;coordinating_in_bytes | The total memory consumed by indexing requests in the coordinating stage, in bytes.
memory.<br>&nbsp;&nbsp;&nbsp;&nbsp;current.<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;primary_in_bytes | Integer | The total memory consumed by indexing requests in the primary stage, in bytes.
memory.<br>&nbsp;&nbsp;&nbsp;&nbsp;current.<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;replica_in_bytes | Integer | The total memory consumed by indexing requests in the replica stage, in bytes.
memory.<br>&nbsp;&nbsp;&nbsp;&nbsp;current.<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;all_in_bytes | Integer | The total memory consumed by indexing requests in the coordinating, primary, or replica stages.
### `shard_indexing_pressure`
The `shard_indexing_pressure` object contains the [shard indexing pressure]({{site.url}}{{site.baseurl}}/opensearch/shard-indexing-backpressure) statistics and has the following properties.
Field | Field type | Description
:--- | :--- | :---
[stats]({{site.url}}{{site.baseurl}}/opensearch/stats-api/) | Object | Statistics about shard indexing pressure.
total_rejections_breakup_shadow_mode | Object | If running in shadow mode, the `total_rejections_breakup_shadow_mode` object contains statistics about the request rejection criteria of all shards in the node.
total_rejections_breakup_shadow_mode.<br>&nbsp;&nbsp;&nbsp;&nbsp;node_limits | Integer | The total number of rejections due to the node memory limit. When all shards reach the memory limit assigned to the node (for example, 10% of heap size), the shard is unable to take in more traffic on the node, and the indexing request is rejected.
total_rejections_breakup_shadow_mode.<br>&nbsp;&nbsp;&nbsp;&nbsp;no_successful_request_limits | Integer | The total number of rejections when the node occupancy level is breaching its soft limit and the shard has multiple outstanding requests that are waiting to be executed. In this case, additional indexing requests are rejected until the system recovers.
total_rejections_breakup_shadow_mode.<br>&nbsp;&nbsp;&nbsp;&nbsp;throughput_degradation_limits | Integer | The total number of rejections when the node occupancy level is breaching its soft limit and there is a constant deterioration in the request turnaround at the shard level. In this case, additional indexing requests are rejected until the system recovers.
enabled | Boolean | Specifies whether the shard indexing pressure feature is turned on for the node.
enforced | Boolean | If true, the shard indexing pressure runs in enforced mode (there are rejections). If false, the shard indexing pressure runs in shadow mode (there are no rejections, but statistics are recorded and can be retrieved in the `total_rejections_breakup_shadow_mode` object). Only applicable if shard indexing pressure is enabled.
## Required permissions
If you use the security plugin, make sure you have the appropriate permissions: `cluster:monitor/nodes/stats`.

10
_opensearch/search-backpressure.md
View File

@ -168,7 +168,7 @@ The response contains server-side request cancellation statistics:
The response contains the following fields.
Field Name | Data Type | Description
Field Name | Data type | Description
:--- | :--- | :---
search_backpressure | Object | Statistics about search backpressure.
search_backpressure.<br>&nbsp;&nbsp;&nbsp;&nbsp;search_shard_task | Object | Statistics specific to the search shard task.
@ -184,7 +184,7 @@ The `resource_tracker_stats` object contains the statistics for each resource tr
The `elapsed_time_tracker` object contains the following statistics related to the elapsed time.
Field Name | Data Type | Description
Field Name | Data type | Description
:--- | :--- | :---
cancellation_count | Integer | The number of tasks canceled because of excessive elapsed time since the node last restarted.
current_max_millis | Integer | The maximum elapsed time for all tasks currently running on the node, in milliseconds.
@ -194,7 +194,7 @@ current_avg_millis | Integer | The average elapsed time for all tasks currently
The `heap_usage_tracker` object contains the following statistics related to the heap usage.
Field Name | Data Type | Description
Field Name | Data type | Description
:--- | :--- | :---
cancellation_count | Integer | The number of tasks canceled because of excessive heap usage since the node last restarted.
current_max_bytes | Integer | The maximum heap usage for all tasks currently running on the node, in bytes.
@ -205,7 +205,7 @@ rolling_avg_bytes | Integer | The rolling average heap usage for `n` most recent
The `cpu_usage_tracker` object contains the following statistics related to the CPU usage.
Field Name | Data Type | Description
Field Name | Data type | Description
:--- | :--- | :---
cancellation_count | Integer | The number of tasks canceled because of excessive CPU usage since the node last restarted.
current_max_millis | Integer | The maximum CPU time for all tasks currently running on the node, in milliseconds.
@ -215,7 +215,7 @@ current_avg_millis | Integer | The average CPU time for all tasks currently runn
The `cancellation_stats` object contains the following statistics for canceled tasks.
Field Name | Data Type | Description
Field Name | Data type | Description
:--- | :--- | :---
cancellation_count | Integer | The total number of tasks canceled since the node last restarted.
cancellation_limit_reached_count | Integer | The number of times when the number of tasks eligible for cancellation exceeded the set cancellation threshold.

2
_opensearch/supported-field-types/xy.md
View File

@ -17,7 +17,7 @@ The coordinates for the Cartesian field types are single-precision floating-poin
The following table lists all Cartesian field types that OpenSearch supports.
Field Data Type | Description
Field Data type | Description
:--- | :---
[`xy_point`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/xy-point/) | A point in a two-dimensional Cartesian coordinate system, specified by x and y coordinates.
[`xy_shape`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/xy-shape/) | A shape, such as a polygon or a collection of xy points, in a two-dimensional Cartesian coordinate system.

4
_security-plugin/audit-logs/storage-types.md
View File

@ -48,7 +48,7 @@ If you use `external_opensearch` and the remote cluster also uses the security p
### TLS settings
Name | Data Type | Description
Name | Data type | Description
:--- | :--- | :---
`plugins.security.audit.config.enable_ssl` | Boolean | If you enabled SSL/TLS on the receiving cluster, set to true. The default is false.
`plugins.security.audit.config.verify_hostnames` | Boolean | Whether to verify the hostname of the SSL/TLS certificate of the receiving cluster. Default is true.
@ -76,7 +76,7 @@ plugins.security.audit.config.password: <password>
Use the following keys to configure the `webhook` storage type.
Name | Data Type | Description
Name | Data type | Description
:--- | :--- | :---
`plugins.security.audit.config.webhook.url` | String | The HTTP or HTTPS URL to send the logs to.
`plugins.security.audit.config.webhook.ssl.verify` | Boolean | If true, the TLS certificate provided by the endpoint (if any) will be verified. If set to false, no verification is performed. You can disable this check if you use self-signed certificates.

2
_security-plugin/configuration/tls.md
View File

@ -173,7 +173,7 @@ You can limit the allowed ciphers and TLS protocols for the REST layer. For exam
If this setting is not enabled, the ciphers and TLS versions are negotiated between the browser and the security plugin automatically, which in some cases can lead to a weaker cipher suite being used. You can configure the ciphers and protocols using the following settings.
Name | Data Type | Description
Name | Data type | Description
:--- | :--- | :---
`plugins.security.ssl.http.enabled_ciphers` | Array | Enabled TLS cipher suites for the REST layer. Only Java format is supported.
`plugins.security.ssl.http.enabled_protocols` | Array | Enabled TLS protocols for the REST layer. Only Java format is supported.