Added couple settings API

Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
This commit is contained in:
keithhc2 2022-02-22 12:30:26 -08:00
parent 6f4542b3a4
commit 4c0e3b863d
4 changed files with 138 additions and 4 deletions

View File

@ -0,0 +1,64 @@
---
layout: default
title: Get settings
parent: Index APIs
grand_parent: REST API reference
nav_order: 100
---
# Get settings
Introduced 1.0
{: .label .label-purple }
The get settings API operation returns all the settings in your index.
## Example
```json
GET /sample-index1/_settings
```
## Path and HTTP methods
```
GET /<target-index>/_settings
GET /<target-index>/_settings/<setting>
```
## URL parameters
All update settings parameters are optional.
Parameter | Data Type | Description
:--- | :--- | :---
&lt;target-index&gt; | String | The index to get settings from. Can be a comma-separated list to get settings from multiple indexes, or use `_all` to return settings from all indexes within the cluster.
&lt;setting&gt; | String | Filter to return specific settings.
allow_no_indices | Boolean | Whether to ignore wildcards that dont match any indexes. Default is `true`.
expand_wildcards | String | Expands wildcard expressions to different indexes. Combine multiple values with commas. Available values are `all` (match all indexes), `open` (match open indexes), `closed` (match closed indexes), `hidden` (match hidden indexes), and `none` (do not accept wildcard expressions), which must be used with `open`, `closed`, or both. Default is `open`.
flat_settings | Boolean | Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example, the flat form of “index”: { “creation_date”: “123456789” } is “index.creation_date”: “123456789”.
include_defaults | String | Whether to include default settings, including settings used within OpenSearch's plugins, in the response. Default is false.
ignore_unavailable | Boolean | If true, OpenSearch does not include missing or closed indexes in the response.
local | Boolean | Whether to return information from the local node only instead of the master node. Default is false.
master_timeout | Time | How long to wait for a connection to the master node. Default is `30s`.
## Response
```json
{
"sample-index1": {
"settings": {
"index": {
"creation_date": "1622672553417",
"number_of_shards": "1",
"number_of_replicas": "1",
"uuid": "GMEA0_TkSaamrnJSzNLzwg",
"version": {
"created": "135217827",
"upgraded": "135238227"
},
"provided_name": "sample-index1"
}
}
}
}
```

View File

@ -1,8 +1,9 @@
---
layout: default
title: Put mapping
parent: REST API reference
nav_order: 30
parent: Index APIs
grand_parent: REST API reference
nav_order: 200
---
# Put mapping

View File

@ -1,8 +1,9 @@
---
layout: default
title: Update mapping
parent: REST API reference
nav_order: 35
parent: Index APIs
grand_parent: REST API reference
nav_order: 220
---
# Update mapping

View File

@ -0,0 +1,68 @@
---
layout: default
title: Update settings
parent: Index APIs
grand_parent: REST API reference
nav_order: 120
---
# Update settings
Introduced 1.0
{: .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).
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`.
## Example
```json
PUT /sample-index1/_settings
{
"index.plugins.index_state_management.rollover_skip": true,
"index": {
"number_of_replicas": 4
}
}
```
## Path and HTTP methods
```
PUT /<target-index>/_settings
```
## URL parameters
All update settings parameters are optional.
Parameter | Data Type | Description
:--- | :--- | :---
allow_no_indices | Boolean | Whether to ignore wildcards that dont match any indexes. Default is `true`.
expand_wildcards | String | Expands wildcard expressions to different indexes. Combine multiple values with commas. Available values are `all` (match all indexes), `open` (match open indexes), `closed` (match closed indexes), `hidden` (match hidden indexes), and `none` (do not accept wildcard expressions), which must be used with `open`, `closed`, or both. Default is `open`.
flat_settings | Boolean | Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example, the flat form of “index”: { “creation_date”: “123456789” } is “index.creation_date”: “123456789”.
ignore_unavailable | Boolean | If true, OpenSearch does not include missing or closed indexes in the response.
preserve_existing | Boolean | Whether to preserve existing index settings. Default is false.
master_timeout | Time | How long to wait for a connection to the master node. Default is `30s`.
timeout | Time | How long to wait for a connection to return. Default is `30s`.
## Request body
The request body must all of the index settings that you want to update.
```json
{
"index.plugins.index_state_management.rollover_skip": true,
"index": {
"number_of_replicas": 4
}
}
```
## Response
```json
{
"acknowledged": true
}
```