Make API reference top level (#1637)

* Make API reference top level

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Fix typo on Drag and Drop page (#1633)

* Fix typo on Drag and Drop page

* Update _dashboards/drag-drop-wizard.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update drag-drop-wizard.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Putting all the Docker install material on a single page (#1452)

* Putting all the Docker install material on a single page

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Making room for revamp

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Intro added

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Continuing to flesh out the intro section and overview

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Overview finalized

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Introducing docker compose

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added link to compose

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Continuing docker image commentary

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Sometimes I wonder if anyone reads these

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Adding notes on installing compose with pip

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Adding prereqs

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Magnets - how do they work?

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Almonds and peaches are part of the same plant subgenus, Amygdalus

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* There are 293 ways to make change for a dollar

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* A shark is the only known fish that can blink with both eyes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* A crocodile cannot stick its tongue out

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* wording

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Reorganizing a couple paragraphs to make it flow better

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Forgot a word

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Add tip about pruning stopped containers

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Cleaning up

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Add blurb about container ls

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Adding the Docker Compose stuff

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Working on compose

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Continuing work on the compose section - it's a lot of info

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added important settings

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Updates to settings that need configured

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Still working through compose things

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Fixed wording

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Working through compose commands and guidance

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Reordering/rewording

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* More phrasing

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* More wording in steps

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* More wording in steps

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Organizing

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Adding stuff and things

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Continuing to work through the configuration steps

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Fixes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Fixes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Still working on the configuration steps

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Changes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* More work

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Removed perf analyzer - refer to GH issue 1555

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Fixing things

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Adding guidance on passing settings in compose

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Working through dockerfile materials now

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* wording

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Finalized the sample dev compose file

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Continuing work with configuration

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Finished - ready for reviews

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Fixed a link I forgot to change before

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Changes from first proofread

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Changed heading

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Addressed reviewer comments and made some changes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Forgot to incorporate one change. Fixed.

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Final editorial changes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* fix#1584-custom_attr_allowlist (#1636)

Signed-off-by: cwillum <cwmmoore@amazon.com>

Signed-off-by: cwillum <cwmmoore@amazon.com>

* Update TERMS.md with definition for Setting (#1632)

* fix#1631-Terms-setting

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#1631-Terms-setting

Signed-off-by: cwillum <cwmmoore@amazon.com>

Signed-off-by: cwillum <cwmmoore@amazon.com>

* Add disclaimer about remote fs usage and an example of setting env var (#1644)

* Add disclaimer about remote fs usage and an example of setting env var

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Enhanced wording a little bit

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* [DOC] New documentation: Self-host maps server (#1625)

* Add new page self-host maps server

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

* Added new content

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

* Copy edit

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

* Tech review edits

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

* Doc review edits

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

* Editorial review changes

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

* Final edits

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

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

* Add feedback.

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Fix links

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
Signed-off-by: cwillum <cwmmoore@amazon.com>
Signed-off-by: vagimeli <vagimeli@amazon.com>
Co-authored-by: Nate Bower <nbower@amazon.com>
Co-authored-by: Jeff Huss <jeffhuss@amazon.com>
Co-authored-by: Chris Moore <107723039+cwillum@users.noreply.github.com>
Co-authored-by: Melissa Vagi <105296784+vagimeli@users.noreply.github.com>
This commit is contained in:
Naarcha-AWS 2022-10-27 11:50:39 -05:00 committed by GitHub
parent 9fb09ba218
commit 7bb41fe4ce
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
112 changed files with 175 additions and 232 deletions

View File

@ -1,8 +1,7 @@
--- ---
layout: default layout: default
title: Alias title: Alias
parent: REST API reference nav_order: 5
nav_order: 20
--- ---
# Alias # Alias

View File

@ -1,7 +1,6 @@
--- ---
layout: default layout: default
title: Analyze API title: Analyze API
parent: REST API reference
has_children: true has_children: true
nav_order: 7 nav_order: 7
redirect_from: redirect_from:

View File

@ -2,7 +2,7 @@
layout: default layout: default
title: Perform text analysis title: Perform text analysis
parent: Analyze API parent: Analyze API
grand_parent: REST API reference
nav_order: 2 nav_order: 2
--- ---
@ -635,7 +635,7 @@ PUT /books2
} }
} }
```` ````
The preceding request is an index API rather than an analyze API. See [DYNAMIC INDEX SETTINGS]({{site.url}}{{site.baseurl}}/opensearch/rest-api/index-apis/create-index/#dynamic-index-settings) for additional details. The preceding request is an index API rather than an analyze API. See [DYNAMIC INDEX SETTINGS]({{site.url}}{{site.baseurl}}/api-reference/index-apis/create-index/#dynamic-index-settings) for additional details.
{: .note} {: .note}
### Response fields ### Response fields

View File

@ -2,7 +2,7 @@
layout: default layout: default
title: Analysis API Terminology title: Analysis API Terminology
parent: Analyze API parent: Analyze API
grand_parent: REST API reference
nav_order: 1 nav_order: 1
--- ---

View File

@ -2,7 +2,7 @@
layout: default layout: default
title: cat aliases title: cat aliases
parent: CAT API parent: CAT API
grand_parent: REST API reference
nav_order: 1 nav_order: 1
has_children: false has_children: false
--- ---
@ -43,7 +43,7 @@ GET _cat/aliases
All cat aliases URL parameters are optional. All cat aliases URL parameters are optional.
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index), you can specify the following parameters: In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
Parameter | Type | Description Parameter | Type | Description
:--- | :--- | :--- :--- | :--- | :---

View File

@ -2,7 +2,7 @@
layout: default layout: default
title: cat allocation title: cat allocation
parent: CAT API parent: CAT API
grand_parent: REST API reference
nav_order: 5 nav_order: 5
has_children: false has_children: false
--- ---
@ -42,7 +42,7 @@ GET _cat/allocation/<node_name>
All cat allocation URL parameters are optional. All cat allocation URL parameters are optional.
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index), you can specify the following parameters: In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
Parameter | Type | Description Parameter | Type | Description
:--- | :--- | :--- :--- | :--- | :---

View File

@ -2,7 +2,7 @@
layout: default layout: default
title: cat cluster manager title: cat cluster manager
parent: CAT API parent: CAT API
grand_parent: REST API reference
nav_order: 30 nav_order: 30
has_children: false has_children: false
--- ---
@ -29,7 +29,7 @@ GET _cat/cluster_manager
All cat cluster manager URL parameters are optional. All cat cluster manager URL parameters are optional.
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index), you can specify the following parameters: In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
Parameter | Type | Description Parameter | Type | Description
:--- | :--- | :--- :--- | :--- | :---

View File

@ -2,7 +2,7 @@
layout: default layout: default
title: cat count title: cat count
parent: CAT API parent: CAT API
grand_parent: REST API reference
nav_order: 10 nav_order: 10
has_children: false has_children: false
--- ---
@ -40,7 +40,7 @@ GET _cat/count/<index>?v
## URL parameters ## URL parameters
All cat count URL parameters are optional. You can specify any of the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index). All cat count URL parameters are optional. You can specify any of the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index).
## Response ## Response

View File

@ -2,7 +2,7 @@
layout: default layout: default
title: cat field data title: cat field data
parent: CAT API parent: CAT API
grand_parent: REST API reference
nav_order: 15 nav_order: 15
has_children: false has_children: false
--- ---
@ -42,7 +42,7 @@ GET _cat/fielddata/<field_name>?v
All cat fielddata URL parameters are optional. All cat fielddata URL parameters are optional.
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index), you can specify the following parameter: In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameter:
Parameter | Type | Description Parameter | Type | Description
:--- | :--- | :--- :--- | :--- | :---

View File

@ -2,7 +2,7 @@
layout: default layout: default
title: cat health title: cat health
parent: CAT API parent: CAT API
grand_parent: REST API reference
nav_order: 20 nav_order: 20
has_children: false has_children: false
--- ---

View File

@ -2,7 +2,7 @@
layout: default layout: default
title: cat indices title: cat indices
parent: CAT API parent: CAT API
grand_parent: REST API reference
nav_order: 25 nav_order: 25
has_children: false has_children: false
--- ---
@ -42,7 +42,7 @@ GET _cat/indices
All cat indices URL parameters are optional. All cat indices URL parameters are optional.
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index), you can specify the following parameters: In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
Parameter | Type | Description Parameter | Type | Description
:--- | :--- | :--- :--- | :--- | :---

View File

@ -2,7 +2,7 @@
layout: default layout: default
title: cat nodeattrs title: cat nodeattrs
parent: CAT API parent: CAT API
grand_parent: REST API reference
nav_order: 35 nav_order: 35
has_children: false has_children: false
--- ---
@ -29,7 +29,7 @@ GET _cat/nodeattrs
All cat nodeattrs URL parameters are optional. All cat nodeattrs URL parameters are optional.
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index), you can specify the following parameters: In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
Parameter | Type | Description Parameter | Type | Description
:--- | :--- | :--- :--- | :--- | :---

View File

@ -2,7 +2,7 @@
layout: default layout: default
title: cat nodes title: cat nodes
parent: CAT API parent: CAT API
grand_parent: REST API reference
nav_order: 40 nav_order: 40
has_children: false has_children: false
--- ---
@ -31,7 +31,7 @@ GET _cat/nodes
All cat nodes URL parameters are optional. All cat nodes URL parameters are optional.
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index), you can specify the following parameters: In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
Parameter | Type | Description Parameter | Type | Description
:--- | :--- | :--- :--- | :--- | :---

View File

@ -2,7 +2,7 @@
layout: default layout: default
title: cat pending tasks title: cat pending tasks
parent: CAT API parent: CAT API
grand_parent: REST API reference
nav_order: 45 nav_order: 45
has_children: false has_children: false
--- ---
@ -29,7 +29,7 @@ GET _cat/pending_tasks
All cat nodes URL parameters are optional. All cat nodes URL parameters are optional.
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index), you can specify the following parameters: In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
Parameter | Type | Description Parameter | Type | Description
:--- | :--- | :--- :--- | :--- | :---

View File

@ -2,7 +2,7 @@
layout: default layout: default
title: cat plugins title: cat plugins
parent: CAT API parent: CAT API
grand_parent: REST API reference
nav_order: 50 nav_order: 50
has_children: false has_children: false
--- ---
@ -29,7 +29,7 @@ GET _cat/plugins
All cat plugins URL parameters are optional. All cat plugins URL parameters are optional.
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index), you can specify the following parameters: In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
Parameter | Type | Description Parameter | Type | Description
:--- | :--- | :--- :--- | :--- | :---

View File

@ -2,7 +2,7 @@
layout: default layout: default
title: cat recovery title: cat recovery
parent: CAT API parent: CAT API
grand_parent: REST API reference
nav_order: 50 nav_order: 50
has_children: false has_children: false
--- ---
@ -41,7 +41,7 @@ GET _cat/recovery
All cat recovery URL parameters are optional. All cat recovery URL parameters are optional.
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index), you can specify the following parameters: In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
Parameter | Type | Description Parameter | Type | Description
:--- | :--- | :--- :--- | :--- | :---

View File

@ -2,7 +2,7 @@
layout: default layout: default
title: cat repositories title: cat repositories
parent: CAT API parent: CAT API
grand_parent: REST API reference
nav_order: 55 nav_order: 55
has_children: false has_children: false
--- ---
@ -29,7 +29,7 @@ GET _cat/repositories
All cat repositories URL parameters are optional. All cat repositories URL parameters are optional.
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index), you can specify the following parameters: In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
Parameter | Type | Description Parameter | Type | Description
:--- | :--- | :--- :--- | :--- | :---

View File

@ -2,7 +2,7 @@
layout: default layout: default
title: cat segments title: cat segments
parent: CAT API parent: CAT API
grand_parent: REST API reference
nav_order: 55 nav_order: 55
has_children: false has_children: false
--- ---
@ -41,7 +41,7 @@ GET _cat/segments
All cat segments URL parameters are optional. All cat segments URL parameters are optional.
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index), you can specify the following parameter: In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameter:
Parameter | Type | Description Parameter | Type | Description
:--- | :--- | :--- :--- | :--- | :---

View File

@ -2,7 +2,7 @@
layout: default layout: default
title: cat shards title: cat shards
parent: CAT API parent: CAT API
grand_parent: REST API reference
nav_order: 60 nav_order: 60
has_children: false has_children: false
--- ---
@ -41,7 +41,7 @@ GET _cat/shards
All cat shards URL parameters are optional. All cat shards URL parameters are optional.
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index), you can specify the following parameter: In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameter:
Parameter | Type | Description Parameter | Type | Description
:--- | :--- | :--- :--- | :--- | :---

View File

@ -2,7 +2,7 @@
layout: default layout: default
title: cat snapshots title: cat snapshots
parent: CAT API parent: CAT API
grand_parent: REST API reference
nav_order: 65 nav_order: 65
has_children: false has_children: false
--- ---
@ -29,7 +29,7 @@ GET _cat/snapshots
All cat snapshots URL parameters are optional. All cat snapshots URL parameters are optional.
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index), you can specify the following parameter: In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameter:
Parameter | Type | Description Parameter | Type | Description
:--- | :--- | :--- :--- | :--- | :---

View File

@ -2,7 +2,7 @@
layout: default layout: default
title: cat tasks title: cat tasks
parent: CAT API parent: CAT API
grand_parent: REST API reference
nav_order: 70 nav_order: 70
has_children: false has_children: false
--- ---
@ -29,7 +29,7 @@ GET _cat/tasks
All cat tasks URL parameters are optional. All cat tasks URL parameters are optional.
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index), you can specify the following parameter: In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameter:
Parameter | Type | Description Parameter | Type | Description
:--- | :--- | :--- :--- | :--- | :---

View File

@ -2,7 +2,7 @@
layout: default layout: default
title: cat templates title: cat templates
parent: CAT API parent: CAT API
grand_parent: REST API reference
nav_order: 70 nav_order: 70
has_children: false has_children: false
--- ---
@ -11,7 +11,7 @@ has_children: false
Introduced 1.0 Introduced 1.0
{: .label .label-purple } {: .label .label-purple }
The cat templates operation lists the names, patterns, order numbers, and version numbers of index templates. The cat Templates operation lists the names, patterns, order numbers, and version numbers of index templates.
## Example ## Example
@ -35,7 +35,7 @@ GET _cat/templates
All cat templates URL parameters are optional. All cat templates URL parameters are optional.
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index), you can specify the following parameter: In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameter:
Parameter | Type | Description Parameter | Type | Description
:--- | :--- | :--- :--- | :--- | :---

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: cat thread pool title: cat thread pool
parent: CAT API parent: CAT API
grand_parent: REST API reference
nav_order: 75 nav_order: 75
has_children: false has_children: false
--- ---
@ -11,7 +10,7 @@ has_children: false
Introduced 1.0 Introduced 1.0
{: .label .label-purple } {: .label .label-purple }
The cat thread pool operation lists the active, queued, and rejected threads of different thread pools on each node. The Cat thread pool operation lists the active, queued, and rejected threads of different thread pools on each node.
## Example ## Example
@ -35,7 +34,7 @@ GET _cat/thread_pool
All cat thread pool URL parameters are optional. All cat thread pool URL parameters are optional.
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index), you can specify the following parameter: In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameter:
Parameter | Type | Description Parameter | Type | Description
:--- | :--- | :--- :--- | :--- | :---

View File

@ -1,22 +1,22 @@
--- ---
layout: default layout: default
title: CAT API title: Compact and aligned text (CAT) API
parent: REST API reference nav_order: 10
nav_order: 100
has_children: true has_children: true
redirect_from: redirect_from:
- /opensearch/catapis/ - /opensearch/catapis/
- /opensearch/rest-api/cat
--- ---
# Compact and aligned text (CAT) API # Compact and aligned text (CAT) API
You can get essential statistics about your cluster in an easy-to-understand, tabular format using the compact and aligned text (CAT) API. The CAT API is a human-readable interface that returns plain text instead of traditional JSON. You can get essential statistics about your cluster in an easy-to-understand, tabular format using the compact and aligned text (CAT) API. The Cat API is a human-readable interface that returns plain text instead of traditional JSON.
Using the CAT API, you can answer questions like which node is the elected master, what state is the cluster in, how many documents are in each index, and so on. Using the Cat API, you can answer questions like which node is the elected master, what state is the cluster in, how many documents are in each index, and so on.
## Example ## Example
To see the available operations in the CAT API, use the following command: To see the available operations in the Cat API, use the following command:
``` ```
GET _cat GET _cat
@ -24,7 +24,7 @@ GET _cat
## Optional query parameters ## Optional query parameters
You can use the following query parameters with any CAT API to filter your results. You can use the following query parameters with any Cat API to filter your results.
Parameter | Description Parameter | Description
:--- | :--- | :--- | :--- |
@ -36,7 +36,7 @@ Parameter | Description
### Query parameter usage examples ### Query parameter usage examples
You can specify a query parameter to any CAT operation to obtain more specific results. You can specify a query parameter to any Cat operation to obtain more specific results.
### Get verbose output ### Get verbose output

View File

@ -1,8 +1,7 @@
--- ---
layout: default layout: default
title: Cluster allocation explain title: Cluster allocation explain
parent: REST API reference nav_order: 15
nav_order: 50
--- ---
# Cluster allocation explain # Cluster allocation explain

View File

@ -1,8 +1,7 @@
--- ---
layout: default layout: default
title: Cluster health title: Cluster health
parent: REST API reference nav_order: 16
nav_order: 55
--- ---
# Cluster health # Cluster health

View File

@ -1,8 +1,7 @@
--- ---
layout: default layout: default
title: Cluster settings title: Cluster settings
parent: REST API reference nav_order: 17
nav_order: 60
--- ---
# Cluster settings # Cluster settings

View File

@ -1,8 +1,7 @@
--- ---
layout: default layout: default
title: Cluster stats title: Cluster stats
parent: REST API reference nav_order: 18
nav_order: 65
--- ---
# Cluster stats # Cluster stats
@ -31,7 +30,7 @@ All cluster stats parameters are optional.
Parameter | Type | Description Parameter | Type | Description
:--- | :--- | :--- :--- | :--- | :---
&lt;node-filters&gt; | List | A comma-separated list of [node filters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/nodes-apis/index/#node-filters) that OpenSearch uses to filter results. &lt;node-filters&gt; | List | A comma-separated list of [node filters]({{site.url}}{{site.baseurl}}/api-reference/nodes-apis/index/#node-filters) that OpenSearch uses to filter results.
Although the `master` node is now called `cluster_manager` for version 2.0, we retained the `master` field for backwards compatibility. If you have a node that has either a `master` role or a `cluster_manager` role, the `count` increases for both fields by 1. To see an example node count increase, see the Response sample. Although the `master` node is now called `cluster_manager` for version 2.0, we retained the `master` field for backwards compatibility. If you have a node that has either a `master` role or a `cluster_manager` role, the `count` increases for both fields by 1. To see an example node count increase, see the Response sample.

View File

@ -1,8 +1,7 @@
--- ---
layout: default layout: default
title: Count title: Count
parent: REST API reference nav_order: 20
nav_order: 150
--- ---
# Count # Count
@ -57,7 +56,7 @@ To see the number of documents in your cluster:
GET _count GET _count
``` ```
Alternatively, you could use the [cat indices]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/cat-indices/) and [cat count]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/cat-count/) APIs to see the number of documents per index or data stream. Alternatively, you could use the [cat indices]({{site.url}}{{site.baseurl}}/api-reference/cat/cat-indices/) and [cat count]({{site.url}}{{site.baseurl}}/api-reference/cat/cat-count/) APIs to see the number of documents per index or data stream.
{: .note } {: .note }

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Bulk title: Bulk
parent: Document APIs parent: Document APIs
grand_parent: REST API reference
nav_order: 20 nav_order: 20
--- ---
@ -35,7 +34,7 @@ POST _bulk
POST <index>/_bulk POST <index>/_bulk
``` ```
Specifying the index in the path means you don't need to include it in the [request body]({{site.url}}{{site.baseurl}}/opensearch/rest-api/document-apis/bulk/#request-body). Specifying the index in the path means you don't need to include it in the [request body]({{site.url}}{{site.baseurl}}/api-reference/document-apis/bulk/#request-body).
OpenSearch also accepts PUT requests to the `_bulk` path, but we highly recommend using POST. The accepted usage of PUT---adding or replacing a single resource at a given path---doesn't make sense for bulk requests. OpenSearch also accepts PUT requests to the `_bulk` path, but we highly recommend using POST. The accepted usage of PUT---adding or replacing a single resource at a given path---doesn't make sense for bulk requests.
{: .note } {: .note }

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Delete by query title: Delete by query
parent: Document APIs parent: Document APIs
grand_parent: REST API reference
nav_order: 40 nav_order: 40
--- ---
@ -69,12 +68,12 @@ terminate_after | Integer | The maximum number of documents OpenSearch should pr
timeout | Time | How long the operation should wait from a response from active shards. Default is `1m`. timeout | Time | How long the operation should wait from a response from active shards. Default is `1m`.
version | Boolean | Whether to include the document version as a match. version | Boolean | Whether to include the document version as a match.
wait_for_active_shards | String | The number of shards that must be active before OpenSearch executes the operation. Valid values are `all` or any integer up to the total number of shards in the index. Default is 1, which is the primary shard. wait_for_active_shards | String | The number of shards that must be active before OpenSearch executes the operation. Valid values are `all` or any integer up to the total number of shards in the index. Default is 1, which is the primary shard.
wait_for_completion | Boolean | Setting this parameter to false indicates to OpenSearch it should not wait for completion and perform this request asynchronously. Asynchronous requests run in the background, and you can use the [Tasks API operation]({{site.url}}{{site.baseurl}}/opensearch/rest-api/tasks) to monitor progress. wait_for_completion | Boolean | Setting this parameter to false indicates to OpenSearch it should not wait for completion and perform this request asynchronously. Asynchronous requests run in the background, and you can use the [Tasks]({{site.url}}{{site.baseurl}}/api-reference/tasks) API to monitor progress.
## Request body ## Request body
To search your index for specific documents, you must include a [query]({{site.url}}{{site.baseurl}}/opensearch/query-dsl/index) in the request body that OpenSearch uses to match documents. If you don't use a query, OpenSearch treats your delete request as a simple [delete document operation]({{site.url}}{{site.baseurl}}/opensearch/rest-api/document-apis/delete-document). To search your index for specific documents, you must include a [query]({{site.url}}{{site.baseurl}}/opensearch/query-dsl/index) in the request body that OpenSearch uses to match documents. If you don't use a query, OpenSearch treats your delete request as a simple [delete document operation]({{site.url}}{{site.baseurl}}/api-reference/document-apis/delete-document).
```json ```json
{ {

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Delete document title: Delete document
parent: Document APIs parent: Document APIs
grand_parent: REST API reference
nav_order: 15 nav_order: 15
--- ---

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Get document title: Get document
parent: Document APIs parent: Document APIs
grand_parent: REST API reference
nav_order: 5 nav_order: 5
--- ---

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Index document title: Index document
parent: Document APIs parent: Document APIs
grand_parent: REST API reference
nav_order: 1 nav_order: 1
--- ---

View File

@ -1,9 +1,8 @@
--- ---
layout: default layout: default
title: Document APIs title: Document APIs
parent: REST API reference
has_children: true has_children: true
nav_order: 40 nav_order: 25
redirect_from: redirect_from:
- /opensearch/rest-api/document-apis/ - /opensearch/rest-api/document-apis/
--- ---

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Multi-get document title: Multi-get document
parent: Document APIs parent: Document APIs
grand_parent: REST API reference
nav_order: 30 nav_order: 30
--- ---

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Reindex title: Reindex
parent: Document APIs parent: Document APIs
grand_parent: REST API reference
nav_order: 60 nav_order: 60
--- ---

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Update by query title: Update by query
parent: Document APIs parent: Document APIs
grand_parent: REST API reference
nav_order: 50 nav_order: 50
--- ---

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Update document title: Update document
parent: Document APIs parent: Document APIs
grand_parent: REST API reference
nav_order: 10 nav_order: 10
--- ---

View File

@ -1,8 +1,7 @@
--- ---
layout: default layout: default
title: Explain title: Explain
parent: REST API reference nav_order: 30
nav_order: 140
--- ---
# Explain # Explain

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Clear Index or Data Stream Cache title: Clear Index or Data Stream Cache
parent: Index APIs parent: Index APIs
grand_parent: REST API reference
nav_order: 320 nav_order: 320
--- ---

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Clone index title: Clone index
parent: Index APIs parent: Index APIs
grand_parent: REST API reference
nav_order: 70 nav_order: 70
--- ---
@ -58,7 +57,7 @@ timeout | Time | How long to wait for the request to return. Default is `30s`.
## Request body ## Request body
The clone index API operation creates a new target index, so you can specify any [index settings]({{site.url}}{{site.baseurl}}/opensearch/rest-api/index-apis/create-index/#index-settings) and [aliases]({{site.url}}{{site.baseurl}}/opensearch/index-alias) to apply to the target index. The clone index API operation creates a new target index, so you can specify any [index settings]({{site.url}}{{site.baseurl}}/api-reference/index-apis/create-index/#index-settings) and [aliases]({{site.url}}{{site.baseurl}}/opensearch/index-alias) to apply to the target index.
## Response ## Response

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Close index title: Close index
parent: Index APIs parent: Index APIs
grand_parent: REST API reference
nav_order: 30 nav_order: 30
--- ---

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Create index title: Create index
parent: Index APIs parent: Index APIs
grand_parent: REST API reference
nav_order: 1 nav_order: 1
--- ---

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Dangling indexes title: Dangling indexes
parent: index-apis parent: index-apis
grand_parent: REST API reference
nav_order: 84 nav_order: 84
--- ---

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Delete index title: Delete index
parent: Index APIs parent: Index APIs
grand_parent: REST API reference
nav_order: 10 nav_order: 10
--- ---

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Index exists title: Index exists
parent: Index APIs parent: Index APIs
grand_parent: REST API reference
nav_order: 5 nav_order: 5
--- ---

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Get index title: Get index
parent: Index APIs parent: Index APIs
grand_parent: REST API reference
nav_order: 20 nav_order: 20
--- ---

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Get settings title: Get settings
parent: Index APIs parent: Index APIs
grand_parent: REST API reference
nav_order: 100 nav_order: 100
--- ---

View File

@ -1,9 +1,8 @@
--- ---
layout: default layout: default
title: Index APIs title: Index APIs
parent: REST API reference
has_children: true has_children: true
nav_order: 3 nav_order: 35
redirect_from: redirect_from:
- /opensearch/rest-api/index-apis/ - /opensearch/rest-api/index-apis/
--- ---

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Open index title: Open index
parent: Index APIs parent: Index APIs
grand_parent: REST API reference
nav_order: 40 nav_order: 40
--- ---

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Create or update mappings title: Create or update mappings
parent: Index APIs parent: Index APIs
grand_parent: REST API reference
nav_order: 220 nav_order: 220
--- ---

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Shrink index title: Shrink index
parent: Index APIs parent: Index APIs
grand_parent: REST API reference
nav_order: 50 nav_order: 50
--- ---
@ -56,6 +55,6 @@ timeout | Time | How long to wait for the request to return a response. Default
You can use the request body to configure some index settings for the target index. All fields are optional. You can use the request body to configure some index settings for the target index. All fields are optional.
Field | Type | Description Field | Type | Description
alias | Object | Sets an alias for the target index. Can have the fields `filter`, `index_routing`, `is_hidden`, `is_write_index`, `routing`, and `search_routing`. See [index aliases]({{site.url}}{{site.baseurl}}/opensearch/rest-api/alias/#request-body). alias | Object | Sets an alias for the target index. Can have the fields `filter`, `index_routing`, `is_hidden`, `is_write_index`, `routing`, and `search_routing`. See [Index Aliases]({{site.url}}{{site.baseurl}}/api-reference/alias/#request-body).
settings | Object | Index settings you can apply to your target index. See [index settings]({{site.url}}{{site.baseurl}}/opensearch/rest-api/index-apis/create-index/#index-settings). settings | Object | Index settings you can apply to your target index. See [Index Settings]({{site.url}}{{site.baseurl}}/api-reference/index-apis/create-index/#index-settings).
max_primary_shard_size | Bytes | Sets the maximum size of a primary shard in the target index. For example, if this field is set to 100 GB, and the source index's primary shards total to 300 GB, then the target index has 3 primary shards of 100 GB each. max_primary_shard_size | Bytes | Sets the maximum size of a primary shard in the target index. For example, if this field is set to 100 GB, and the source index's primary shards total to 300 GB, then the target index has 3 primary shards of 100 GB each.

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Split index title: Split index
parent: Index APIs parent: Index APIs
grand_parent: REST API reference
nav_order: 80 nav_order: 80
--- ---
@ -58,7 +57,7 @@ timeout | Time | How long to wait for the request to return. Default is `30s`.
## Request body ## Request body
The split index API operation creates a new target index, so you can specify any [index settings]({{site.url}}{{site.baseurl}}/opensearch/rest-api/index-apis/create-index/#index-settings) and [aliases]({{site.url}}{{site.baseurl}}/opensearch/index-alias) to apply to the target index. The split index API operation creates a new target index, so you can specify any [index settings]({{site.url}}{{site.baseurl}}/api-reference/index-apis/create-index/#index-settings) and [aliases]({{site.url}}{{site.baseurl}}/opensearch/index-alias) to apply to the target index.
## Response ## Response

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Update settings title: Update settings
parent: Index APIs parent: Index APIs
grand_parent: REST API reference
nav_order: 120 nav_order: 120
--- ---
@ -10,7 +9,7 @@ nav_order: 120
Introduced 1.0 Introduced 1.0
{: .label .label-purple } {: .label .label-purple }
You can use the update settings API operation to update index-level settings. You can change dynamic index settings at any time, but static settings cannot be changed after index creation. For more information about static and dynamic index settings, see [Create index]({{site.url}}{{site.baseurl}}/opensearch/rest-api/index-apis/create-index/#index-settings). You can use the update settings API operation to update index-level settings. You can change dynamic index settings at any time, but static settings cannot be changed after index creation. For more information about static and dynamic index settings, see [Create index]({{site.url}}{{site.baseurl}}/api-reference/index-apis/create-index).
Aside from the static and dynamic index settings, you can also update individual plugins' settings. To get the full list of updatable settings, run `GET <target-index>/_settings?include_defaults=true`. Aside from the static and dynamic index settings, you can also update individual plugins' settings. To get the full list of updatable settings, run `GET <target-index>/_settings?include_defaults=true`.

View File

@ -1,8 +1,7 @@
--- ---
layout: default layout: default
title: REST API reference title: REST API reference
nav_order: 99 nav_order: 1
has_children: true
redirect_from: redirect_from:
- /opensearch/rest-api/ - /opensearch/rest-api/
--- ---

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Create or update ingest pipeline title: Create or update ingest pipeline
parent: Ingest APIs parent: Ingest APIs
grand_parent: REST API reference
nav_order: 11 nav_order: 11
--- ---

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Delete a pipeline title: Delete a pipeline
parent: Ingest APIs parent: Ingest APIs
grand_parent: REST API reference
nav_order: 14 nav_order: 14
--- ---

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Get ingest pipeline title: Get ingest pipeline
parent: Ingest APIs parent: Ingest APIs
grand_parent: REST API reference
nav_order: 10 nav_order: 10
--- ---

View File

@ -1,9 +1,8 @@
--- ---
layout: default layout: default
title: Ingest APIs title: Ingest APIs
parent: REST API reference
has_children: true has_children: true
nav_order: 4 nav_order: 40
redirect_from: redirect_from:
- /opensearch/rest-api/ingest-apis/ - /opensearch/rest-api/ingest-apis/
--- ---

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Simulate an ingest pipeline title: Simulate an ingest pipeline
parent: Ingest APIs parent: Ingest APIs
grand_parent: REST API reference
nav_order: 13 nav_order: 13
--- ---

View File

@ -1,8 +1,7 @@
--- ---
layout: default layout: default
title: Multi-search title: Multi-search
parent: REST API reference nav_order: 45
nav_order: 130
--- ---
# Multi-search # Multi-search
@ -49,7 +48,7 @@ Query\n
- Metadata lines include options, such as which indices to search and the type of search. - Metadata lines include options, such as which indices to search and the type of search.
- Query lines use the [query DSL]({{site.url}}{{site.baseurl}}/opensearch/query-dsl/). - Query lines use the [query DSL]({{site.url}}{{site.baseurl}}/opensearch/query-dsl/).
Just like the [bulk]({{site.url}}{{site.baseurl}}/opensearch/rest-api/document-apis/bulk/) operation, the JSON doesn't need to be minified---spaces are fine---but it does need to be on a single line. OpenSearch uses newline characters to parse multi-search requests and requires that the request body end with a newline character. Just like the [bulk]({{site.url}}{{site.baseurl}}/api-reference/document-apis/bulk/) operation, the JSON doesn't need to be minified---spaces are fine---but it does need to be on a single line. OpenSearch uses newline characters to parse multi-search requests and requires that the request body end with a newline character.
## URL parameters and metadata options ## URL parameters and metadata options
@ -59,7 +58,7 @@ All multi-search URL parameters are optional. Some can also be applied per-searc
Parameter | Type | Description | Supported in metadata line Parameter | Type | Description | Supported in metadata line
:--- | :--- | :--- :--- | :--- | :---
allow_no_indices | Boolean | Whether to ignore wildcards that don't match any indices. Default is `true`. | Yes allow_no_indices | Boolean | Whether to ignore wildcards that don't match any indices. Default is `true`. | Yes
cancel_after_time_interval | Time | The time after which the search request will be canceled. Supported at both parent and child request levels. The order of precedence is:<br> 1. Child-level parameter<br> 2. Parent-level parameter<br> 3. [Cluster setting]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cluster-settings).<br>Default is -1. | Yes cancel_after_time_interval | Time | The time after which the search request will be canceled. Supported at both parent and child request levels. The order of precedence is:<br> 1. Child-level parameter<br> 2. Parent-level parameter<br> 3. [Cluster setting]({{site.url}}{{site.baseurl}}/api-reference/cluster-settings).<br>Default is -1. | Yes
css_minimize_roundtrips | Boolean | Whether OpenSearch should try to minimize the number of network round trips between the coordinating node and remote clusters (only applicable to cross-cluster search requests). Default is `true`. | No css_minimize_roundtrips | Boolean | Whether OpenSearch should try to minimize the number of network round trips between the coordinating node and remote clusters (only applicable to cross-cluster search requests). Default is `true`. | No
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`. | Yes 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`. | Yes
ignore_unavailable | Boolean | If an index from the indices list doesnt exist, whether to ignore it rather than fail the query. Default is `false`. | Yes ignore_unavailable | Boolean | If an index from the indices list doesnt exist, whether to ignore it rather than fail the query. Default is `false`. | Yes

View File

@ -1,9 +1,8 @@
--- ---
layout: default layout: default
title: Nodes APIs title: Nodes APIs
parent: REST API reference
has_children: true has_children: true
nav_order: 5 nav_order: 50
--- ---
# Nodes API # Nodes API

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Nodes hot threads title: Nodes hot threads
parent: Nodes APIs parent: Nodes APIs
grand_parent: REST API reference
nav_order: 30 nav_order: 30
--- ---
@ -29,7 +28,7 @@ You can include the following optional path parameter in your request.
Parameter | Type | Description Parameter | Type | Description
:--- | :--- | :--- :--- | :--- | :---
nodeId | String | A comma-separated list of node IDs used to filter results. Supports [node filters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/nodes-apis/index/#node-filters). Defaults to `_all`. nodeId | String | A comma-separated list of node IDs used to filter results. Supports [node filters]({{site.url}}{{site.baseurl}}/api-reference/nodes-apis/index/#node-filters). Defaults to `_all`.
## Query parameters ## Query parameters

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Nodes info title: Nodes info
parent: Nodes APIs parent: Nodes APIs
grand_parent: REST API reference
nav_order: 10 nav_order: 10
--- ---
@ -48,7 +47,7 @@ The following table lists the available path parameters. All path parameters are
Parameter | Type | Description 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`. nodeId | String | A comma-separated list of nodeIds used to filter results. Supports [node filters]({{site.url}}{{site.baseurl}}/api-reference/nodes-apis/index/#node-filters). Defaults to `_all`.
metrics | String | A comma-separated list of metric groups that will be included in the response. For example, `jvm,thread_pool`. Defaults to all metrics. metrics | String | A comma-separated list of metric groups that will be included in the response. For example, `jvm,thread_pool`. Defaults to all metrics.
The following table lists all available metric groups. The following table lists all available metric groups.

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Nodes reload secure settings title: Nodes reload secure settings
parent: Nodes APIs parent: Nodes APIs
grand_parent: REST API reference
nav_order: 50 nav_order: 50
--- ---
@ -23,7 +22,7 @@ You can include the following optional path parameter in your request.
Parameter | Type | Description 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`. nodeId | String | A comma-separated list of nodeIds used to filter results. Supports [node filters]({{site.url}}{{site.baseurl}}/api-reference/nodes-apis/index/#node-filters). Defaults to `_all`.
## Request fields ## Request fields

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Nodes stats title: Nodes stats
parent: Nodes APIs parent: Nodes APIs
grand_parent: REST API reference
nav_order: 20 nav_order: 20
--- ---
@ -27,7 +26,7 @@ The following table lists the available path parameters. All path parameters are
Parameter | Type | Description 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`. nodeId | String | A comma-separated list of nodeIds used to filter results. Supports [node filters]({{site.url}}{{site.baseurl}}/api-reference/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. 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. 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.

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Nodes usage title: Nodes usage
parent: Nodes APIs parent: Nodes APIs
grand_parent: REST API reference
nav_order: 40 nav_order: 40
--- ---
@ -25,7 +24,7 @@ You can include the following optional path parameters in your request.
Parameter | Type | Description 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`. nodeId | String | A comma-separated list of nodeIds used to filter results. Supports [node filters]({{site.url}}{{site.baseurl}}/api-reference/nodes-apis/index/#node-filters). Defaults to `_all`.
metric | String | The metrics that will be included in the response. You can set the string to either `_all` or `rest_actions`. `rest_actions` returns the total number of times an action has been called on the node. `_all` returns all stats from the node. Defaults to `_all`. metric | String | The metrics that will be included in the response. You can set the string to either `_all` or `rest_actions`. `rest_actions` returns the total number of times an action has been called on the node. `_all` returns all stats from the node. Defaults to `_all`.
## Query parameters ## Query parameters

View File

@ -1,8 +1,7 @@
--- ---
layout: default layout: default
title: Ranking evaluation title: Ranking evaluation
parent: REST API reference nav_order: 60
nav_order: 82
--- ---
# Ranking evaluation # Ranking evaluation

View File

@ -1,8 +1,7 @@
--- ---
layout: default layout: default
title: Reload search analyzer title: Reload search analyzer
parent: REST API reference nav_order: 65
nav_order: 83
--- ---
# Reload search analyzer # Reload search analyzer

View File

@ -1,8 +1,7 @@
--- ---
layout: default layout: default
title: Remote cluster information title: Remote cluster information
parent: REST API reference nav_order: 67
nav_order: 70
--- ---
# Remote cluster information # Remote cluster information

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Create or Update Stored Script title: Create or Update Stored Script
parent: Script APIs parent: Script APIs
grand_parent: REST API reference
nav_order: 1 nav_order: 1
--- ---
@ -10,7 +9,7 @@ nav_order: 1
Creates or updates a stored script or search template. Creates or updates a stored script or search template.
For additonal information about Painless scripting, see: For additional information about Painless scripting, see:
* [k-NN Painless Scripting extensions]({{site.url}}{{site.baseurl}}/search-plugins/knn/painless-functions/). * [k-NN Painless Scripting extensions]({{site.url}}{{site.baseurl}}/search-plugins/knn/painless-functions/).
@ -44,8 +43,7 @@ All parameters are optional.
| Field | Data Type | Description | | Field | Data Type | Description |
:--- | :--- | :--- :--- | :--- | :---
| lang | String | Scripting language. Required. | | 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 API]({{site.url}}{{site.baseurl}}/opensearch/rest-api/search)'s request body. Search templates also support Mustache variables. | | 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. |
| params | Object | The script's or search template's parameters. |
#### Sample request #### Sample request
@ -92,7 +90,7 @@ curl -XPUT "http://opensearch:9200/_scripts/my-first-script" -H 'Content-Type: a
}' }'
```` ````
See [Execute Painless stored script]({{site.url}}{{site.baseurl}}/opensearch/rest-api/_script-apis/exec-stored-script) for information about running the script. See [Execute Painless stored script]({{site.url}}{{site.baseurl}}/api-reference/script-apis/exec-stored-script/) for information about running the script.
#### Sample response #### Sample response
@ -104,7 +102,7 @@ The `PUT _scripts/my-first-script` request returns the following field:
} }
```` ````
To determine whether the script was successfully created, use the [Get stored script]({{site.url}}{{site.baseurl}}/opensearch/rest-api/_script-apis/get-stored-script/) API, passing the script name as the `script` path parameter. To determine whether the script was successfully created, use the [Get stored script]({{site.url}}{{site.baseurl}}/api-reference/script-apis/get-stored-script/) API, passing the script name as the `script` path parameter.
{: .note} {: .note}
### Response fields ### Response fields

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Delete Script title: Delete Script
parent: Script APIs parent: Script APIs
grand_parent: REST API reference
nav_order: 4 nav_order: 4
--- ---
@ -43,7 +42,7 @@ The `DELETE _scripts/my-first-script` request returns the following field:
} }
```` ````
To determine whether the stored script was successfully deleted, use the [Get stored script]({{site.url}}{{site.baseurl}}/opensearch/rest-api/_script-apis/get-stored-script/) API, passing the script name as the `script` path parameter. To determine whether the stored script was successfully deleted, use the [Get stored script]({{site.url}}{{site.baseurl}}/api-reference/script-apis/get-stored-script/) API, passing the script name as the `script` path parameter.
### Response fields ### Response fields

View File

@ -1,8 +1,7 @@
--- ---
layout: default layout: default
title: Execute Painless Stored Script title: Execute Painless stored script
parent: Script APIs parent: Script APIs
grand_parent: REST API reference
nav_order: 2 nav_order: 2
--- ---
@ -22,13 +21,13 @@ OpenSearch provides several ways to run a script; the following sections show ho
#### Sample request #### Sample request
The following request runs the stored script that was created in [Create or Update Stored Script]({{site.url}}{{site.baseurl}}/opensearch/rest-api/_script-apis/create-stored-script/). The script sums the ratings for each book and displays the sum in the `total_ratings` field in the output. The following request runs the stored script that was created in [Create or update stored script]({{site.url}}{{site.baseurl}}/api-reference/script-apis/create-stored-script/). The script sums the ratings for each book and displays the sum in the `total_ratings` field in the output.
* The script's target is the `books` index. * The script's target is the `books` index.
* The `"match_all": {}` property value is an empty object indicating to process each document in the index. * The `"match_all": {}` property value is an empty object indicating to process each document in the index.
* The `total_ratings` field value is the result of the `my-first-script` execution. (See [Create or Update Stored Script]({{site.url}}{{site.baseurl}}/opensearch/rest-api/_script-apis/create-stored-script/).) * The `total_ratings` field value is the result of the `my-first-script` execution. See [Create or update stored script]({{site.url}}{{site.baseurl}}/api-reference/script-apis/create-stored-script/).
````json ````json
GET books/_search GET books/_search

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Get Stored Script Contexts title: Get Stored Script Contexts
parent: Script APIs parent: Script APIs
grand_parent: REST API reference
nav_order: 5 nav_order: 5
--- ---

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Get Script Language title: Get Script Language
parent: Script APIs parent: Script APIs
grand_parent: REST API reference
nav_order: 6 nav_order: 6
--- ---

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Get Stored Script title: Get Stored Script
parent: Script APIs parent: Script APIs
grand_parent: REST API reference
nav_order: 3 nav_order: 3
--- ---

View File

@ -0,0 +1,20 @@
---
layout: default
title: Script APIs
has_children: true
nav_order: 70
redirect_from:
- /opensearch/rest-api/script-apis/
---
# Script APIs
The script APIs allow you to work with stored scripts. Stored scripts are part of the cluster state and reduce compilation time and enhance search speed. The default scripting language is Painless.
You can perform the following operations on stored scripts:
* [Create or update stored script]({{site.url}}{{site.baseurl}}/api-reference/script-apis/create-stored-script/)
* [Execute Painless stored script]({{site.url}}{{site.baseurl}}/api-reference/script-apis/exec-stored-script/)
* [Get stored script]({{site.url}}{{site.baseurl}}/api-reference/script-apis/get-stored-script/)
* [Delete script]({{site.url}}{{site.baseurl}}/api-reference/script-apis/delete-script/)
* [Get stored script contexts]({{site.url}}{{site.baseurl}}/api-reference/script-apis/get-script-contexts/).
* [Get script language]({{site.url}}{{site.baseurl}}/api-reference/script-apis/get-script-language/)

View File

@ -1,8 +1,7 @@
--- ---
layout: default layout: default
title: Scroll title: Scroll
parent: REST API reference nav_order: 71
nav_order: 120
--- ---
# Scroll # Scroll

View File

@ -1,8 +1,7 @@
--- ---
layout: default layout: default
title: Search title: Search
parent: REST API reference nav_order: 75
nav_order: 10
--- ---
# Search # Search
@ -45,7 +44,7 @@ allow_partial_search_results | Boolean | Whether to return partial results if th
analyzer | String | Analyzer to use in the query string. analyzer | String | Analyzer to use in the query string.
analyze_wildcard | Boolean | Whether the update operation should include wildcard and prefix queries in the analysis. Default is false. analyze_wildcard | Boolean | Whether the update operation should include wildcard and prefix queries in the analysis. Default is false.
batched_reduce_size | Integer | How many shard results to reduce on a node. Default is 512. batched_reduce_size | Integer | How many shard results to reduce on a node. Default is 512.
cancel_after_time_interval | Time | The time after which the search request will be canceled. Request-level parameter takes precedence over cancel_after_time_interval [cluster setting]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cluster-settings). Default is -1. cancel_after_time_interval | Time | The time after which the search request will be canceled. Request-level parameter takes precedence over cancel_after_time_interval [cluster setting]({{site.url}}{{site.baseurl}}/api-reference/cluster-settings). Default is -1.
ccs_minimize_roundtrips | Boolean | Whether to minimize roundtrips between a node and remote clusters. Default is true. ccs_minimize_roundtrips | Boolean | Whether to minimize roundtrips between a node and remote clusters. Default is true.
default_operator | String | Indicates whether the default operator for a string query should be AND or OR. Default is OR. default_operator | String | Indicates whether the default operator for a string query should be AND or OR. Default is OR.
df | String | The default field in case a field prefix is not provided in the query string. df | String | The default field in case a field prefix is not provided in the query string.

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Register Snapshot Repository title: Register Snapshot Repository
parent: Snapshot APIs parent: Snapshot APIs
grand_parent: REST API reference
nav_order: 1 nav_order: 1
--- ---
@ -84,5 +83,6 @@ Upon success, the following JSON object is returned:
"acknowledged": true "acknowledged": true
} }
``` ```
To verify that the repository was registered, use the [Get snapshot repository API]({{site.url}}{{site.baseurl}}/opensearch/rest-api/snapshots/get-snapshot-repository), passing the repository name as the `repository` path parameter.
To verify that the repository was registered, use the [Get snapshot repository]({{site.url}}{{site.baseurl}}/api-reference/snapshots/get-snapshot-repository) API, passing the repository name as the `repository` path parameter.
{: .note} {: .note}

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Create Snapshot title: Create Snapshot
parent: Snapshot APIs parent: Snapshot APIs
grand_parent: REST API reference
nav_order: 5 nav_order: 5
--- ---
@ -12,7 +11,7 @@ Creates a snapshot within an existing repository.
* To learn more about snapshots, see [Snapshots]({{site.url}}{{site.baseurl}}/opensearch/snapshots/index). * To learn more about snapshots, see [Snapshots]({{site.url}}{{site.baseurl}}/opensearch/snapshots/index).
* To view a list of your repositories, see [Get snapshot repository]({{site.url}}{{site.baseurl}}/opensearch//rest-api/snapshots/get-snapshot-repository). * To view a list of your repositories, see [Get snapshot repository]({{site.url}}{{site.baseurl}}/api-reference/snapshots/get-snapshot-repository).
### Path parameters ### Path parameters
@ -42,7 +41,7 @@ Field | Data Type | Description
##### Request without a body ##### Request without a body
The following request creates a snapshoted called `my-first-snapshot` in an S3 repository called `my-s3-repository`. A request body is not included because it is optional. The following request creates a snapshot called `my-first-snapshot` in an S3 repository called `my-s3-repository`. A request body is not included because it is optional.
```json ```json
POST _snapshot/my-s3-repository/my-first-snapshot POST _snapshot/my-s3-repository/my-first-snapshot
@ -60,7 +59,7 @@ PUT _snapshot/my-s3-repository/2
"include_global_state": false, "include_global_state": false,
"partial": false "partial": false
} }
```` ```
#### Sample responses #### Sample responses
@ -73,7 +72,8 @@ Upon success, the response content depends on whether you include the `wait_for_
"accepted": true "accepted": true
} }
``` ```
To verify that the snapshot was created, use the [Get snapshot API]({{site.url}}{{site.baseurl}}/opensearch/rest-api/snapshots/get-snapshot), passing the snapshot name as the `snapshot` path parameter.
To verify that the snapshot was created, use the [Get snapshot]({{site.url}}{{site.baseurl}}/api-reference/snapshots/get-snapshot) API, passing the snapshot name as the `snapshot` path parameter.
{: .note} {: .note}
##### `wait_for_completion` included ##### `wait_for_completion` included

View File

@ -2,17 +2,16 @@
layout: default layout: default
title: Delete Snapshot Repository title: Delete Snapshot Repository
parent: Snapshot APIs parent: Snapshot APIs
grand_parent: REST API reference
nav_order: 3 nav_order: 3
--- ---
## Delete snapshot repository configuration. ## Delete snapshot repository configuration
Deletes a snapshot repository configuration. Deletes a snapshot repository configuration.
A repository in OpenSearch is simply a configuration that maps a repository name to a type (file system or s3 repository) along with other information depending on the type. The configuration is backed by a file system location or an s3 bucket. When you invoke the API, the physical file system or s3 bucket itself is not deleted. Only the configuration is deleted. A repository in OpenSearch is simply a configuration that maps a repository name to a type (file system or s3 repository) along with other information depending on the type. The configuration is backed by a file system location or an s3 bucket. When you invoke the API, the physical file system or s3 bucket itself is not deleted. Only the configuration is deleted.
To learn more about repositories, see [Register or update snapshot repository]({{site.url}}{{site.baseurl}}/opensearch/rest-api/snapshots/create-repository). To learn more about repositories, see [Register or update snapshot repository]({{site.url}}{{site.baseurl}}/api-reference/snapshots/create-repository).
### Path parameters ### Path parameters
@ -37,5 +36,6 @@ Upon success, the response returns the following JSON object:
"acknowledged" : true "acknowledged" : true
} }
```` ````
To verify that the repository was deleted, use the [Get snapshot repository API]({{site.url}}{{site.baseurl}}/opensearch/rest-api/snapshots/get-snapshot-repository), passing the repository name as the `repository` path parameter.
To verify that the repository was deleted, use the [Get snapshot repository]({{site.url}}{{site.baseurl}}/api-reference/snapshots/get-snapshot-repository) API, passing the repository name as the `repository` path parameter.
{: .note} {: .note}

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Delete Snapshot title: Delete Snapshot
parent: Snapshot APIs parent: Snapshot APIs
grand_parent: REST API reference
nav_order: 7 nav_order: 7
--- ---
@ -12,9 +11,9 @@ Deletes a snapshot from a repository.
* To learn more about snapshots, see [Snapshots]({{site.url}}{{site.baseurl}}/opensearch/snapshots/index). * To learn more about snapshots, see [Snapshots]({{site.url}}{{site.baseurl}}/opensearch/snapshots/index).
* To view a list of your repositories, see [cat repositories]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/cat-repositories). * To view a list of your repositories, see [cat repositories]({{site.url}}{{site.baseurl}}/api-reference/cat/cat-repositories).
* To view a list of your snapshots, see [cat snapshots]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/cat-snapshots). * To view a list of your snapshots, see [cat snapshots]({{site.url}}{{site.baseurl}}/api-reference/cat/cat-snapshots).
### Path parameters ### Path parameters
@ -39,5 +38,5 @@ Upon success, the response returns the following JSON object:
} }
``` ```
To verify that the snapshot was deleted, use the [Get snapshot API]({{site.url}}{{site.baseurl}}/opensearch/rest-api/snapshots/get-snapshot), passing the snapshot name as the `snapshot` path parameter. To verify that the snapshot was deleted, use the [Get snapshot]({{site.url}}{{site.baseurl}}/api-reference/snapshots/get-snapshot) API, passing the snapshot name as the `snapshot` path parameter.
{: .note} {: .note}

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Get Snapshot Repository title: Get Snapshot Repository
parent: Snapshot APIs parent: Snapshot APIs
grand_parent: REST API reference
nav_order: 2 nav_order: 2
--- ---
@ -12,7 +11,7 @@ Retrieves information about a snapshot repository.
To learn more about repositories, see [Register repository]({{site.url}}{{site.baseurl}}/opensearch/snapshots/snapshot-restore#register-repository). To learn more about repositories, see [Register repository]({{site.url}}{{site.baseurl}}/opensearch/snapshots/snapshot-restore#register-repository).
You can also get details about a snapshot during and after snapshot creation. See [Get snapshot status]({{site.url}}{{site.baseurl}}/opensearch/rest-api/snapshots/get-snapshot-status/). You can also get details about a snapshot during and after snapshot creation. See [Get snapshot status]({{site.url}}{{site.baseurl}}/api-reference/snapshots/get-snapshot-status/).
{: .note} {: .note}
### Path parameters ### Path parameters

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Get Snapshot Status title: Get Snapshot Status
parent: Snapshot APIs parent: Snapshot APIs
grand_parent: REST API reference
nav_order: 8 nav_order: 8
--- ---
@ -10,7 +9,7 @@ nav_order: 8
Returns details about a snapshots state during and after snapshot creation. Returns details about a snapshots state during and after snapshot creation.
To learn about snapshot creation, see [Create snapshot]({{site.url}}{{site.baseurl}}/opensearch/rest-api/snapshots/create-snapshot). To learn about snapshot creation, see [Create snapshot]({{site.url}}{{site.baseurl}}/api-reference/snapshots/create-snapshot).
If you use the security plugin, you must have the `monitor_snapshot`, `create_snapshot`, or `manage cluster` privileges. If you use the security plugin, you must have the `monitor_snapshot`, `create_snapshot`, or `manage cluster` privileges.
{: .note} {: .note}
@ -386,7 +385,7 @@ The `GET _snapshot/my-opensearch-repo/my-first-snapshot/_status` request returns
:--- | :--- | :--- | :--- |
| FAILED | The snapshot terminated in an error and no data was stored. | | FAILED | The snapshot terminated in an error and no data was stored. |
| IN_PROGRESS | The snapshot is currently running. | | IN_PROGRESS | The snapshot is currently running. |
| PARTIAL | The global cluster state was stored, but data from at least one shard was not stored. The `failures` property of the [Create snapshot]({{site.url}}{{site.baseurl}}/opensearch/rest-api/snapshots/create-snapshot) response contains additional details. | | PARTIAL | The global cluster state was stored, but data from at least one shard was not stored. The `failures` property of the [Create snapshot]({{site.url}}{{site.baseurl}}/api-reference/snapshots/create-snapshot) response contains additional details. |
| SUCCESS | The snapshot finished and all shards were stored successfully. | | SUCCESS | The snapshot finished and all shards were stored successfully. |
##### Shard stats ##### Shard stats

View File

@ -2,7 +2,6 @@
layout: default layout: default
title: Get Snapshot title: Get Snapshot
parent: Snapshot APIs parent: Snapshot APIs
grand_parent: REST API reference
nav_order: 6 nav_order: 6
--- ---

View File

@ -1,11 +1,11 @@
--- ---
layout: default layout: default
title: Snapshot APIs title: Snapshot APIs
parent: REST API reference
has_children: true has_children: true
nav_order: 6 nav_order: 80
redirect_from: redirect_from:
- /opensearch/rest-api/document-apis/ - /opensearch/rest-api/document-apis/
- /opensearch/rest-api/snapshots/
--- ---
# Snapshot APIs # Snapshot APIs

View File

@ -2,7 +2,7 @@
layout: default layout: default
title: Restore Snapshot title: Restore Snapshot
parent: Snapshot APIs parent: Snapshot APIs
grand_parent: REST API reference
nav_order: 9 nav_order: 9
--- ---
@ -14,7 +14,7 @@ Restores a snapshot of a cluster or specified data streams and indices.
* For information about data streams, see [Data streams]({{site.url}}{{site.baseurl}}/opensearch/data-streams). * For information about data streams, see [Data streams]({{site.url}}{{site.baseurl}}/opensearch/data-streams).
If open indices with the same name that you want to restore already exist in the cluster, you must close, delete, or rename the indices. See [Sample Request](#sample-request) for information about renaming an index. See [Close index]({{site.url}}{{site.baseurl}}/opensearch/rest-api/index-apis/close-index) for information about closing an index. If open indices with the same name that you want to restore already exist in the cluster, you must close, delete, or rename the indices. See [Sample Request](#sample-request) for information about renaming an index. See [Close index]({{site.url}}{{site.baseurl}}/api-reference/index-apis/close-index) for information about closing an index.
{: .note} {: .note}
### Path parameters ### Path parameters
@ -86,7 +86,7 @@ Upon success, the response returns the following JSON object:
} }
} }
```` ````
Except for the snapshot name, all properties are empty or `0`. This is because any changes made to the volume after the snapshot was generated are lost. However, if you invoke the [Get snapshot]({{site.url}}{{site.baseurl}}/opensearch/rest-api/snapshots/get-snapshot) API to examine the snapshot, a fully populated snapshot object is returned. Except for the snapshot name, all properties are empty or `0`. This is because any changes made to the volume after the snapshot was generated are lost. However, if you invoke the [Get snapshot]({{site.url}}{{site.baseurl}}/api-reference/snapshots/get-snapshot) API to examine the snapshot, a fully populated snapshot object is returned.
### Response fields ### Response fields

View File

@ -2,7 +2,7 @@
layout: default layout: default
title: Verify Snaphot Repository title: Verify Snaphot Repository
parent: Snapshot APIs parent: Snapshot APIs
grand_parent: REST API reference
nav_order: 4 nav_order: 4
--- ---

View File

@ -1,8 +1,7 @@
--- ---
layout: default layout: default
title: Tasks title: Tasks
parent: REST API reference nav_order: 85
nav_order: 80
--- ---
# Tasks # Tasks

View File

@ -487,8 +487,8 @@ document_id_field | No | String | The field from the source data to use for the
dlq_file | No | String | The path to your preferred dead letter queue file (e.g. `/your/local/dlq-file`). Data Prepper writes to this file when it fails to index a document on the OpenSearch cluster. dlq_file | No | String | The path to your preferred dead letter queue file (e.g. `/your/local/dlq-file`). Data Prepper writes to this file when it fails to index a document on the OpenSearch cluster.
bulk_size | No | Integer (long) | The maximum size (in MiB) of bulk requests to the OpenSearch cluster. Values below 0 indicate an unlimited size. If a single document exceeds the maximum bulk request size, Data Prepper sends it individually. Default is 5. bulk_size | No | Integer (long) | The maximum size (in MiB) of bulk requests to the OpenSearch cluster. Values below 0 indicate an unlimited size. If a single document exceeds the maximum bulk request size, Data Prepper sends it individually. Default is 5.
ism_policy_file | No | String | The absolute file path for an ISM (Index State Management) policy JSON file. This policy file is effective only when there is no built-in policy file for the index type. For example, `custom` index type is currently the only one without a built-in policy file, thus it would use the policy file here if it's provided through this parameter. For more information, see [ISM policies]({{site.url}}{{site.baseurl}}/im-plugin/ism/policies/). ism_policy_file | No | String | The absolute file path for an ISM (Index State Management) policy JSON file. This policy file is effective only when there is no built-in policy file for the index type. For example, `custom` index type is currently the only one without a built-in policy file, thus it would use the policy file here if it's provided through this parameter. For more information, see [ISM policies]({{site.url}}{{site.baseurl}}/im-plugin/ism/policies/).
number_of_shards | No | Integer | The number of primary shards that an index should have on the destination OpenSearch server. This parameter is effective only when `template_file` is either explicitly provided in Sink configuration or built-in. If this parameter is set, it would override the value in index template file. For more information, see [create index]({{site.url}}{{site.baseurl}}/opensearch/rest-api/index-apis/create-index/). number_of_shards | No | Integer | The number of primary shards that an index should have on the destination OpenSearch server. This parameter is effective only when `template_file` is either explicitly provided in Sink configuration or built-in. If this parameter is set, it would override the value in index template file. For more information, see [Create index]({{site.url}}{{site.baseurl}}/api-reference/index-apis/create-index/).
number_of_replicas | No | Integer | The number of replica shards each primary shard should have on the destination OpenSearch server. For example, if you have 4 primary shards and set number_of_replicas to 3, the index has 12 replica shards. This parameter is effective only when `template_file` is either explicitly provided in Sink configuration or built-in. If this parameter is set, it would override the value in index template file. For more information, see [create index]({{site.url}}{{site.baseurl}}/opensearch/rest-api/index-apis/create-index/). number_of_replicas | No | Integer | The number of replica shards each primary shard should have on the destination OpenSearch server. For example, if you have 4 primary shards and set number_of_replicas to 3, the index has 12 replica shards. This parameter is effective only when `template_file` is either explicitly provided in Sink configuration or built-in. If this parameter is set, it would override the value in index template file. For more information, see [Create index]({{site.url}}{{site.baseurl}}/api-reference/index-apis/create-index/).
### file ### file

View File

@ -64,6 +64,9 @@ collections:
clients: clients:
permalink: /:collection/:path/ permalink: /:collection/:path/
output: true output: true
api-reference:
permalink: /:collection/:path/
output: true
troubleshoot: troubleshoot:
permalink: /:collection/:path/ permalink: /:collection/:path/
output: true output: true
@ -112,6 +115,9 @@ just_the_docs:
clients: clients:
name: Clients and tools name: Clients and tools
nav_fold: true nav_fold: true
api-reference:
name: API reference
nav_fold: true
troubleshoot: troubleshoot:
name: Troubleshooting name: Troubleshooting
nav_fold: true nav_fold: true

View File

@ -11,7 +11,7 @@ You *can* start OpenSearch Dashboards using `docker run` after [creating a Docke
1. Run `docker pull opensearchproject/opensearch-dashboards:{{site.opensearch_dashboards_version}}`. 1. Run `docker pull opensearchproject/opensearch-dashboards:{{site.opensearch_dashboards_version}}`.
1. Create a [`docker-compose.yml`](https://docs.docker.com/compose/compose-file/) file appropriate for your environment. A sample file that includes OpenSearch Dashboards is available on the OpenSearch [Docker installation page]({{site.url}}{{site.baseurl}}/opensearch/install/docker#sample-docker-compose-file). 1. Create a [`docker-compose.yml`](https://docs.docker.com/compose/compose-file/) file appropriate for your environment. A sample file that includes OpenSearch Dashboards is available on the OpenSearch [Docker installation page]({{site.url}}{{site.baseurl}}/opensearch/install/docker#sample-docker-composeyml).
Just like `opensearch.yml`, you can pass a custom `opensearch_dashboards.yml` to the container in the Docker Compose file. Just like `opensearch.yml`, you can pass a custom `opensearch_dashboards.yml` to the container in the Docker Compose file.
{: .tip } {: .tip }

View File

@ -196,7 +196,7 @@ Parameter | Description | Type | Example | Required
`aliases` | Aliases to add to the new index. | object | `myalias` | No, but must be an array of alias objects `aliases` | Aliases to add to the new index. | object | `myalias` | No, but must be an array of alias objects
`force_unsafe` | If true, executes the shrink action even if there are no replicas. | boolean | `false` | No `force_unsafe` | If true, executes the shrink action even if there are no replicas. | boolean | `false` | No
If you want to add `aliases` to the action, the parameter must include an array of [alias objects]({{site.url}}{{site.baseurl}}/opensearch/rest-api/alias/). For example, If you want to add `aliases` to the action, the parameter must include an array of [alias objects]({{site.url}}{{site.baseurl}}/api-reference/alias/). For example,
```json ```json
"aliases": [ "aliases": [

View File

@ -488,16 +488,16 @@ To create a cluster metrics monitor:
### Supported APIs ### Supported APIs
Trigger conditions use responses from the following APIs. Most APIs that can be used to monitor cluster status support path parameters as described in their documentation (e.g., comma-separated lists of index names). However, they do not support query parameters. Trigger conditions use responses from the following cat API endpoints. Most APIs that can be used to monitor cluster status support path parameters as described in their documentation (e.g., comma-separated lists of index names). However, they do not support query parameters.
1. [_cluster/health]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cluster-health/) 1. [_cluster/health]({{site.url}}{{site.baseurl}}/api-reference/cluster-health/)
2. [_cluster/stats]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cluster-stats/) 2. [_cluster/stats]({{site.url}}{{site.baseurl}}/api-reference/cluster-stats/)
3. [_cluster/settings]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cluster-settings/) 3. [_cluster/settings]({{site.url}}{{site.baseurl}}/api-reference/cluster-settings/)
4. [_nodes/stats]({{site.url}}{{site.baseurl}}/opensearch/popular-api/#get-node-statistics) 4. [_nodes/stats]({{site.url}}{{site.baseurl}}/opensearch/popular-api/#get-node-statistics)
5. [_cat/pending_tasks]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/cat-pending-tasks/) 5. [_cat/pending_tasks]({{site.url}}{{site.baseurl}}/api-reference/cat/cat-pending-tasks/)
6. [_cat/recovery]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/cat-recovery/) 6. [_cat/recovery]({{site.url}}{{site.baseurl}}/api-reference/cat/cat-recovery/)
7. [_cat/snapshots]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/cat-snapshots/) 7. [_cat/snapshots]({{site.url}}{{site.baseurl}}/api-reference/cat/cat-snapshots/)
8. [_cat/tasks]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/cat-tasks/) 8. [_cat/tasks]({{site.url}}{{site.baseurl}}/api-reference/cat/cat-tasks/)
### Restrict API fields ### Restrict API fields

View File

@ -298,6 +298,6 @@ The following is an example response:
Further documentation on the use of performance analyzer and RCA can be found at the following links: Further documentation on the use of performance analyzer and RCA can be found at the following links:
- [Performance analyzer API guide]({{site.url}}{{site.baseurl}}/monitoring-plugins/pa/api/). - [Performance analyzer API guide]({{site.url}}{{site.baseurl}}/monitoring-plugins/pa/api/).
- [Root cause analysis]({{site.url}}{{site.baseurl}}/monitoring-plugins/pa/rca/index/). - [RCA]({{site.url}}{{site.baseurl}}/monitoring-plugins/pa/rca/index/).
- [Root cause analysis API guide]({{site.url}}{{site.baseurl}}/latest/monitoring-plugins/pa/rca/api/). - [RCA API guide]({{site.url}}{{site.baseurl}}/monitoring-plugins/pa/rca/api/).
- [RFC: Root cause analysis](https://github.com/opensearch-project/performance-analyzer-rca/blob/main/docs/rfc-rca.pdf). - [RFC: Root cause analysis](https://github.com/opensearch-project/performance-analyzer-rca/blob/main/docs/rfc-rca.pdf).

View File

@ -65,7 +65,8 @@ PUT _cluster/settings
} }
``` ```
For more information on the Cluster Settings API, see the [Cluster Settings API]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cluster-settings/) documentation. For more information about the Cluster Settings API, see [Cluster settings]({{site.url}}{{site.baseurl}}/api-reference/cluster-settings/).
--- ---

View File

@ -187,7 +187,7 @@ You can use composable index templates to overcome these challenges. Composable
You can combine component templates to compose an index template. You can combine component templates to compose an index template.
Settings and mappings that you specify directly in the [create index]({{site.url}}{{site.baseurl}}/opensearch/rest-api/index-apis/create-index/) request override any settings or mappings specified in an index template and its component templates. Settings and mappings that you specify directly in the [create index]({{site.url}}{{site.baseurl}}/api-reference/index-apis/create-index/) request override any settings or mappings specified in an index template and its component templates.
{: .note } {: .note }
### Create a component template ### Create a component template

View File

@ -135,6 +135,7 @@ docker-compose up -f /path/to/your-file.yml
If this is your first time launching an OpenSearch cluster using Docker Compose, use the following example `docker-compose.yml` file. Save it in the home directory of your host and name it `docker-compose.yml`. This file will create a cluster that contains three containers: two containers running the OpenSearch service and a single container running OpenSearch Dashboards. These containers will communicate over a bridge network called `opensearch-net` and use two volumes, one for each OpenSearch node. Because this file does not explicitly disable the demo security configuration, self-signed TLS certificates are installed and internal users with default names and passwords are created. If this is your first time launching an OpenSearch cluster using Docker Compose, use the following example `docker-compose.yml` file. Save it in the home directory of your host and name it `docker-compose.yml`. This file will create a cluster that contains three containers: two containers running the OpenSearch service and a single container running OpenSearch Dashboards. These containers will communicate over a bridge network called `opensearch-net` and use two volumes, one for each OpenSearch node. Because this file does not explicitly disable the demo security configuration, self-signed TLS certificates are installed and internal users with default names and passwords are created.
### Sample docker-compose.yml ### Sample docker-compose.yml
```yml ```yml
version: '3' version: '3'
services: services:

Some files were not shown because too many files have changed in this diff Show More