Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backports #2946 #3316

Merged
merged 3 commits into from
Mar 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions _api-reference/alias.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ POST _aliases
]
}
```
{% include copy-curl.html %}

## Path and HTTP methods

Expand Down Expand Up @@ -77,3 +78,5 @@ search_routing | String | Assigns a custom value to a shard only for search oper
"acknowledged": true
}
```

For more alias API operations, see [Index aliases]({{site.url}}{{site.baseurl}}/opensearch/index-alias/).
12 changes: 6 additions & 6 deletions _api-reference/analyze-apis/perform-text-analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,15 @@ 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.

## Query parameters

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.
Expand All @@ -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.

Expand Down Expand Up @@ -656,14 +656,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.
Expand All @@ -673,7 +673,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.
Expand Down
4 changes: 2 additions & 2 deletions _api-reference/cat/cat-allocation.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-refe
Parameter | Type | Description
:--- | :--- | :---
bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
local | Boolean | Whether to return information from the local node only instead of from the cluster_manager node. Default is false.
cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster_manager node. Default is 30 seconds.

## Response

Expand Down
14 changes: 7 additions & 7 deletions _api-reference/cat/cat-cluster_manager.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,40 @@
---
layout: default
title: CAT master
title: CAT cluster manager
parent: CAT API

nav_order: 30
has_children: false
---

# CAT master
# CAT cluster_manager
Introduced 1.0
{: .label .label-purple }

The CAT master operation lists information that helps identify the elected master node.
The CAT cluster manager operation lists information that helps identify the elected cluster manager node.

## Example

```
GET _cat/master?v
GET _cat/cluster_manager?v
```
{% include copy-curl.html %}

## Path and HTTP methods

```
GET _cat/master
GET _cat/cluster_manager
```

## URL parameters

All CAT master URL parameters are optional.
All CAT cluster manager URL parameters are optional.

In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:

Parameter | Type | Description
:--- | :--- | :---
master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.
## Response

```json
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-indices.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Parameter | Type | Description
bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
health | String | Limit indices based on their health status. Supported values are `green`, `yellow`, and `red`.
include_unloaded_segments | Boolean | Whether to include information from segments not loaded into memory. Default is false.
master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.
pri | Boolean | Whether to return information only from the primary shards. Default is false.
time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
expand_wildcards | Enum | Expands wildcard expressions to concrete indices. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`. Default is `open`.
Expand Down
4 changes: 2 additions & 2 deletions _api-reference/cat/cat-nodeattrs.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-refe

Parameter | Type | Description
:--- | :--- | :---
local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
local | Boolean | Whether to return information from the local node only instead of from the cluster_manager node. Default is false.
cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.


## Response
Expand Down
8 changes: 4 additions & 4 deletions _api-reference/cat/cat-nodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Introduced 1.0

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

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

## Example

Expand All @@ -38,15 +38,15 @@ Parameter | Type | Description
:--- | :--- | :---
bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
full_id | Boolean | If true, return the full node ID. If false, return the shortened node ID. Defaults to false.
local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
local | Boolean | Whether to return information from the local node only instead of from the cluster_manager node. Default is false.
cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.
time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
include_unloaded_segments | Boolean | Whether to include information from segments not loaded into memory. Default is false.


## Response

```json
ip | heap.percent | ram.percent | cpu load_1m | load_5m | load_15m | node.role | node.roles | master | name
ip | heap.percent | ram.percent | cpu load_1m | load_5m | load_15m | node.role | node.roles | cluster_manager | name
10.11.1.225 | 31 | 32 | 0 | 0.00 | 0.00 | di | data,ingest,ml | - | data-e5b89ad7
```
4 changes: 2 additions & 2 deletions _api-reference/cat/cat-pending-tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-refe

Parameter | Type | Description
:--- | :--- | :---
local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
local | Boolean | Whether to return information from the local node only instead of from the cluster_manager node. Default is false.
cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.
time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).

## Response
Expand Down
4 changes: 2 additions & 2 deletions _api-reference/cat/cat-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-refe

Parameter | Type | Description
:--- | :--- | :---
local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
local | Boolean | Whether to return information from the local node only instead of from the cluster_manager node. Default is false.
cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster_manager node. Default is 30 seconds.

## Response

Expand Down
4 changes: 2 additions & 2 deletions _api-reference/cat/cat-repositories.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-refe

Parameter | Type | Description
:--- | :--- | :---
local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
local | Boolean | Whether to return information from the local node only instead of from the cluster_manager node. Default is false.
cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster_manager node. Default is 30 seconds.


## Response
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-segments.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-refe
Parameter | Type | Description
:--- | :--- | :---
bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/)..
master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.


## Response
Expand Down
4 changes: 2 additions & 2 deletions _api-reference/cat/cat-shards.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-refe
Parameter | Type | Description
:--- | :--- | :---
bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
local | Boolean | Whether to return information from the local node only instead of from the cluster_manager node. Default is false.
cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster_manager node. Default is 30 seconds.
time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).


Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-snapshots.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-refe

Parameter | Type | Description
:--- | :--- | :---
master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.
time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).


Expand Down
4 changes: 2 additions & 2 deletions _api-reference/cat/cat-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-refe

Parameter | Type | Description
:--- | :--- | :---
local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
local | Boolean | Whether to return information from the local node only instead of from the cluster manager node. Default is false.
cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.


## Response
Expand Down
4 changes: 2 additions & 2 deletions _api-reference/cat/cat-thread-pool.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-refe

Parameter | Type | Description
:--- | :--- | :---
local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
local | Boolean | Whether to return information from the local node only instead of from the cluster_manager node. Default is false.
cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster_manager node. Default is 30 seconds.


## Response
Expand Down
Loading