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

Add documentation for reload_searchIanalyzer api (#1339) 

* updated incorrect links

Signed-off-by: ariamarble <armarble@amazon.com>

* add documentation for reload search analyzer api

Signed-off-by: ariamarble <armarble@amazon.com>

* made suggested changes

Signed-off-by: ariamarble <armarble@amazon.com>

* made additional formatting changes

Signed-off-by: ariamarble <armarble@amazon.com>

* made editorial changes

Signed-off-by: ariamarble <armarble@amazon.com>

Signed-off-by: ariamarble <armarble@amazon.com>
This commit is contained in:
Aria Marble 2022-10-03 12:24:36 -07:00 committed by GitHub
parent 05f466d2af
commit 7d41fc58c4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 60 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
_opensearch/rest-api/reload-search-analyzer.md Normal file
View File

@ -0,0 +1,60 @@
---
layout: default
title: Reload search analyzer
parent: REST API reference
nav_order: 83
---
# Reload search analyzer
The reload search analyzer API operation detects any changes to [synonym]({{site.url}}{{site.baseurl}}/opensearch/ux/) files for any configured [search analyzers]({{site.url}}{{site.baseurl}}/im-plugin/refresh-analyzer/index/). The reload search analyzer request needs to be run on all nodes. Additionally, the synonym token filter must be set to `true`.
## Path and HTTP methods
```
POST /<index>/_reload_search_analyzers
GET /<index>/_reload_search_analyzers
```
## Request body fields
Request body parameters are optional.
Field Type | Data Type | Description
:--- | :--- | :---
allow_no_indices | Boolean | When set to `false`, an error is returned for indexes that are closed or missing and match any wildcard expression. Default is set to `true`.
expand_wildcards | String | Allows you to set the wildcards that can be matched to a type of index. Available options are `open`, `closed`, `all`, `none`, and `hidden`. Default is set to `open`.
ignore_unavailable | Boolean | If an index is closed or missing, an error is returned when ignore_unavailable is set to `false`. Default is set to `false`.
## Examples
The following are an example request and response.
#### Sample request
````json
POST /shakespeare/_reload_search_analyzers
````
#### Sample response
````json
{
"_shards": {
"total": 1,
"successful": 1,
"failed": 0
},
"reload_details": [
{
"index": "shakespeare",
"reloaded_analyzers": [
"analyzers-synonyms-test"
],
"reloaded_node_ids": [
"opensearch-node1"
]
}
]
}
````