more api redirects (#4013)
Signed-off-by: Heather Halter <hdhalter@amazon.com>
This commit is contained in:
Heather Halter
GitHub
parent
e9db6d6043
commit
d1c22f9f68
|
|
@ -2,13 +2,15 @@
|
|||
layout: default
|
||||
title: Alias
|
||||
nav_order: 5
|
||||
Redirect_from:
|
||||
- /opensearch/rest-api/alias/
|
||||
---
|
||||
|
||||
# Alias
|
||||
Introduced 1.0
|
||||
{: .label .label-purple }
|
||||
|
||||
An alias is a virtual pointer that you can use to reference one or more indices. Creating and updating aliases are atomic operations, so you can reindex your data and point an alias at it without any downtime.
|
||||
An alias is a virtual pointer that you can use to reference one or more indexes. Creating and updating aliases are atomic operations, so you can reindex your data and point an alias at it without any downtime.
|
||||
|
||||
|
||||
## Example
|
||||
|
|
|
|||
|
|
@ -3,6 +3,8 @@ layout: default
|
|||
title: Delete by query
|
||||
parent: Document APIs
|
||||
nav_order: 40
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/document-apis/delete-by-query/
|
||||
---
|
||||
|
||||
# Delete by query
|
||||
|
|
|
|||
|
|
@ -3,6 +3,8 @@ layout: default
|
|||
title: Delete document
|
||||
parent: Document APIs
|
||||
nav_order: 15
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/document-apis/delete-document/
|
||||
---
|
||||
|
||||
# Delete document
|
||||
|
|
@ -67,7 +69,7 @@ _version | The document's version.
|
|||
_result | The result of the delete operation.
|
||||
_shards | Detailed information about the cluster's shards.
|
||||
total | The total number of shards.
|
||||
successful | The number of shards OpenSearch succssfully deleted the document from.
|
||||
successful | The number of shards OpenSearch successfully deleted the document from.
|
||||
failed | The number of shards OpenSearch failed to delete the document from.
|
||||
_seq_no | The sequence number assigned when the document was indexed.
|
||||
_primary_term | The primary term assigned when the document was indexed.
|
||||
|
|
|
|||
|
|
@ -3,6 +3,8 @@ layout: default
|
|||
title: Get document
|
||||
parent: Document APIs
|
||||
nav_order: 5
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/document-apis/get-documents/
|
||||
---
|
||||
|
||||
# Get document
|
||||
|
|
@ -69,7 +71,7 @@ Field | Description
|
|||
_index | The name of the index.
|
||||
_id | The document's ID.
|
||||
_version | The document's version number. Updated whenever the document changes.
|
||||
_seq_no | The sequnce number assigned when the document is indexed.
|
||||
_seq_no | The sequence number assigned when the document is indexed.
|
||||
primary_term | The primary term assigned when the document is indexed.
|
||||
found | Whether the document exists.
|
||||
_routing | The shard that the document is routed to. If the document is not routed to a particular shard, this field is omitted.
|
||||
|
|
|
|||
|
|
@ -2,7 +2,8 @@
|
|||
layout: default
|
||||
title: Index document
|
||||
parent: Document APIs
|
||||
nav_order: 1
|
||||
nav_order: 1redirect_from:
|
||||
- /opensearch/rest-api/document-apis/index-document
|
||||
---
|
||||
|
||||
# Index document
|
||||
|
|
@ -88,7 +89,7 @@ _version | The document's version.
|
|||
result | The result of the index operation.
|
||||
_shards | Detailed information about the cluster's shards.
|
||||
total | The total number of shards.
|
||||
successful | The number of shards OpenSearch succssfully added the document to.
|
||||
successful | The number of shards OpenSearch successfully added the document to.
|
||||
failed | The number of shards OpenSearch failed to added the document to.
|
||||
_seq_no | The sequence number assigned when the document was indexed.
|
||||
_primary_term | The primary term assigned when the document was indexed.
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ title: Document APIs
|
|||
has_children: true
|
||||
nav_order: 25
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/document-apis/
|
||||
- /opensearch/rest-api/document-apis/index/
|
||||
---
|
||||
|
||||
# Document APIs
|
||||
|
|
|
|||
|
|
@ -3,6 +3,8 @@ layout: default
|
|||
title: Multi-get document
|
||||
parent: Document APIs
|
||||
nav_order: 30
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/document-apis/mulit-get/
|
||||
---
|
||||
|
||||
# Multi-get documents
|
||||
|
|
@ -78,7 +80,7 @@ _source_includes | String | A comma-separated list of source fields to include i
|
|||
|
||||
## Request body
|
||||
|
||||
If you don't specify an index in your request's URL, you must specify your target indices and the relevant document IDs in the request body. Other fields are optional.
|
||||
If you don't specify an index in your request's URL, you must specify your target indexes and the relevant document IDs in the request body. Other fields are optional.
|
||||
|
||||
Field | Type | Description | Required
|
||||
:--- | :--- | :--- | :---
|
||||
|
|
@ -130,7 +132,7 @@ Field | Description
|
|||
_index | The name of the index.
|
||||
_id | The document's ID.
|
||||
_version | The document's version number. Updated whenever the document changes.
|
||||
_seq_no | The sequnce number assigned when the document is indexed.
|
||||
_seq_no | The sequence number assigned when the document is indexed.
|
||||
primary_term | The primary term assigned when the document is indexed.
|
||||
found | Whether the document exists.
|
||||
_routing | The shard that the document is routed to. If the document is not routed to a particular shard, this field is omitted.
|
||||
|
|
|
|||
|
|
@ -3,6 +3,8 @@ layout: default
|
|||
title: Reindex document
|
||||
parent: Document APIs
|
||||
nav_order: 60
|
||||
redirect_from:
|
||||
- /opensearch/reindex-data/
|
||||
---
|
||||
|
||||
# Reindex document
|
||||
|
|
|
|||
|
|
@ -3,6 +3,8 @@ layout: default
|
|||
title: Update by query
|
||||
parent: Document APIs
|
||||
nav_order: 50
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/document-apis/update-by-query/
|
||||
---
|
||||
|
||||
# Update by query
|
||||
|
|
@ -44,16 +46,16 @@ All URL parameters are optional.
|
|||
|
||||
Parameter | Type | Description
|
||||
:--- | :--- | :--- | :---
|
||||
<index> | String | Comma-separated list of indices to update. To update all indices, use * or omit this parameter.
|
||||
allow_no_indices | Boolean | Whether to ignore wildcards that don’t match any indices. Default is `true`.
|
||||
<index> | String | Comma-separated list of indexes to update. To update all indexes, use * or omit this parameter.
|
||||
allow_no_indices | Boolean | Whether to ignore wildcards that don’t match any indexes. Default is `true`.
|
||||
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.
|
||||
conflicts | String | Indicates to OpenSearch what should happen if the update by query operation runs into a version conflict. Valid options are `abort` and `proceed`. Default is `abort`.
|
||||
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 if a field prefix is not provided in the query string.
|
||||
expand_wildcards | String | Specifies the type of index that wildcard expressions can match. Supports comma-separated values. Valid values are `all` (match any index), `open` (match open, non-hidden indices), `closed` (match closed, non-hidden indices), `hidden` (match hidden indices), and `none` (deny wildcard expressions). Default is `open`.
|
||||
expand_wildcards | String | Specifies the type of index that wildcard expressions can match. Supports comma-separated values. Valid values are `all` (match any index), `open` (match open, non-hidden indexes), `closed` (match closed, non-hidden indexes), `hidden` (match hidden indexes), and `none` (deny wildcard expressions). Default is `open`.
|
||||
from | Integer | The starting index to search from. Default is 0.
|
||||
ignore_unavailable | Boolean | Whether to exclude missing or closed indices in the response. Default is false.
|
||||
ignore_unavailable | Boolean | Whether to exclude missing or closed indexes in the response. Default is false.
|
||||
lenient | Boolean | Specifies whether OpenSearch should accept requests if queries have format errors (for example, querying a text field for an integer). Default is false.
|
||||
max_docs | Integer | How many documents the update by query operation should process at most. Default is all documents.
|
||||
pipeline | String | ID of the pipeline to use to process documents.
|
||||
|
|
@ -65,7 +67,7 @@ requests_per_second | Integer | Specifies the request's throttling in sub-reques
|
|||
routing | String | Value used to route the update by query operation to a specific shard.
|
||||
scroll | Time | How long to keep the search context open.
|
||||
scroll_size | Integer | Size of the operation's scroll request. Default is 1000.
|
||||
search_type | String | Whether OpenSearch should use global term and document frequencies calculating revelance scores. Valid choices are `query_then_fetch` and `dfs_query_then_fetch`. `query_then_fetch` scores documents using local term and document frequencies for the shard. It’s usually faster but less accurate. `dfs_query_then_fetch` scores documents using global term and document frequencies across all shards. It’s usually slower but more accurate. Default is `query_then_fetch`.
|
||||
search_type | String | Whether OpenSearch should use global term and document frequencies calculating relevance scores. Valid choices are `query_then_fetch` and `dfs_query_then_fetch`. `query_then_fetch` scores documents using local term and document frequencies for the shard. It’s usually faster but less accurate. `dfs_query_then_fetch` scores documents using global term and document frequencies across all shards. It’s usually slower but more accurate. Default is `query_then_fetch`.
|
||||
search_timeout | Time | How long to wait until OpenSearch deems the request timed out. Default is no timeout.
|
||||
slices | Integer | Number of sub-tasks OpenSearch should divide this task into. Default is 1, which means OpenSearch should not divide this task.
|
||||
sort | List | A comma-separated list of <field> : <direction> pairs to sort by.
|
||||
|
|
@ -81,7 +83,7 @@ wait_for_completion | boolean | When set to `false`, the response body includes
|
|||
|
||||
## Request body
|
||||
|
||||
To update your indices and documents by query, you must include a [query]({{site.url}}{{site.baseurl}}/opensearch/query-dsl/index) and a script in the request body that OpenSearch can run to update your documents. If you don't specify a query, then every document in the index gets updated.
|
||||
To update your indexes and documents by query, you must include a [query]({{site.url}}{{site.baseurl}}/opensearch/query-dsl/index) and a script in the request body that OpenSearch can run to update your documents. If you don't specify a query, then every document in the index gets updated.
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
|
|||
|
|
@ -3,6 +3,8 @@ layout: default
|
|||
title: Update document
|
||||
parent: Document APIs
|
||||
nav_order: 10
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/document-apis/update-document/
|
||||
---
|
||||
|
||||
# Update document
|
||||
|
|
@ -144,7 +146,7 @@ _version | The document's version.
|
|||
_result | The result of the delete operation.
|
||||
_shards | Detailed information about the cluster's shards.
|
||||
total | The total number of shards.
|
||||
successful | The number of shards OpenSearch succssfully deleted the document from.
|
||||
successful | The number of shards OpenSearch successfully deleted the document from.
|
||||
failed | The number of shards OpenSearch failed to delete the document from.
|
||||
_seq_no | The sequence number assigned when the document was indexed.
|
||||
_primary_term | The primary term assigned when the document was indexed.
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ title: Create or update mappings
|
|||
parent: Index APIs
|
||||
nav_order: 220
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/index-apis/put-mapping/
|
||||
- /opensearch/rest-api/index-apis/update-mapping/
|
||||
---
|
||||
|
||||
# Create or update mappings
|
||||
|
|
|
|||
|
|
@ -6,6 +6,7 @@ has_children: false
|
|||
redirect_from:
|
||||
- /im-plugin/
|
||||
- /opensearch/index-data/
|
||||
- /opensearch/rest-api/index-apis/index/
|
||||
---
|
||||
|
||||
# Managing indexes
|
||||
|
|
|
|||
Loading…
Reference in New Issue