fixindexapiorder (#4146)
Signed-off-by: Heather Halter <hdhalter@amazon.com>
This commit is contained in:
parent
3e3a54d312
commit
9cf4cd203e
|
@ -1,9 +1,11 @@
|
||||||
---
|
---
|
||||||
layout: default
|
layout: default
|
||||||
title: Alias
|
title: Alias
|
||||||
|
parent: Index APIs
|
||||||
nav_order: 5
|
nav_order: 5
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /opensearch/rest-api/alias/
|
- /opensearch/rest-api/alias/
|
||||||
|
- /api-reference/alias/
|
||||||
---
|
---
|
||||||
|
|
||||||
# Alias
|
# Alias
|
|
@ -2,10 +2,10 @@
|
||||||
layout: default
|
layout: default
|
||||||
title: Clear Index or Data Stream Cache
|
title: Clear Index or Data Stream Cache
|
||||||
parent: Index APIs
|
parent: Index APIs
|
||||||
nav_order: 320
|
nav_order: 10
|
||||||
---
|
---
|
||||||
|
|
||||||
## Clear index or data stream cache
|
# Clear index or data stream cache
|
||||||
|
|
||||||
The clear cache API operation clears the caches of one or more indexes. For data streams, the API clears the caches of the stream’s backing indexes.
|
The clear cache API operation clears the caches of one or more indexes. For data streams, the API clears the caches of the stream’s backing indexes.
|
||||||
|
|
||||||
|
@ -13,14 +13,14 @@ The clear cache API operation clears the caches of one or more indexes. For data
|
||||||
If you use the Security plugin, you must have the `manage index` privileges.
|
If you use the Security plugin, you must have the `manage index` privileges.
|
||||||
{: .note}
|
{: .note}
|
||||||
|
|
||||||
### Path parameters
|
## Path parameters
|
||||||
|
|
||||||
| Parameter | Data type | Description |
|
| Parameter | Data type | Description |
|
||||||
:--- | :--- | :---
|
:--- | :--- | :---
|
||||||
| target | String | Comma-delimited list of data streams, indexes, and index aliases to which cache clearing will be applied. Wildcard expressions (`*`) are supported. To target all data streams and indexes in a cluster, omit this parameter or use `_all` or `*`. Optional. |
|
| target | String | Comma-delimited list of data streams, indexes, and index aliases to which cache clearing will be applied. Wildcard expressions (`*`) are supported. To target all data streams and indexes in a cluster, omit this parameter or use `_all` or `*`. Optional. |
|
||||||
|
|
||||||
|
|
||||||
### Query parameters
|
## Query parameters
|
||||||
|
|
||||||
All query parameters are optional.
|
All query parameters are optional.
|
||||||
|
|
||||||
|
@ -35,11 +35,11 @@ All query parameters are optional.
|
||||||
| query | Boolean | If `true`, clears the query cache. Defaults to `true`. |
|
| query | Boolean | If `true`, clears the query cache. Defaults to `true`. |
|
||||||
| request | Boolean | If `true`, clears the request cache. Defaults to `true`. |
|
| request | Boolean | If `true`, clears the request cache. Defaults to `true`. |
|
||||||
|
|
||||||
#### Example requests
|
## Example requests
|
||||||
|
|
||||||
The following example requests show multiple clear cache API uses.
|
The following example requests show multiple clear cache API uses.
|
||||||
|
|
||||||
##### Clear a specific cache
|
### Clear a specific cache
|
||||||
|
|
||||||
The following request clears the fields cache only:
|
The following request clears the fields cache only:
|
||||||
|
|
||||||
|
@ -66,7 +66,7 @@ POST /my-index/_cache/clear?request=true
|
||||||
````
|
````
|
||||||
{% include copy-curl.html %}
|
{% include copy-curl.html %}
|
||||||
|
|
||||||
##### Clear the cache for specific fields
|
### Clear the cache for specific fields
|
||||||
|
|
||||||
The following request clears the fields caches of `fielda` and `fieldb`:
|
The following request clears the fields caches of `fielda` and `fieldb`:
|
||||||
|
|
||||||
|
@ -75,7 +75,7 @@ POST /my-index/_cache/clear?fields=fielda,fieldb
|
||||||
````
|
````
|
||||||
{% include copy-curl.html %}
|
{% include copy-curl.html %}
|
||||||
|
|
||||||
##### Clear caches for specific data streams and indexes
|
### Clear caches for specific data streams and indexes
|
||||||
|
|
||||||
The following request clears the cache for two specific indexes:
|
The following request clears the cache for two specific indexes:
|
||||||
|
|
||||||
|
@ -84,7 +84,7 @@ POST /my-index,my-index2/_cache/clear
|
||||||
````
|
````
|
||||||
{% include copy-curl.html %}
|
{% include copy-curl.html %}
|
||||||
|
|
||||||
##### Clear caches for all data streams and indexes
|
### Clear caches for all data streams and indexes
|
||||||
|
|
||||||
The following request clears the cache for all data streams and indexes:
|
The following request clears the cache for all data streams and indexes:
|
||||||
|
|
||||||
|
@ -93,7 +93,7 @@ POST /_cache/clear
|
||||||
````
|
````
|
||||||
{% include copy-curl.html %}
|
{% include copy-curl.html %}
|
||||||
|
|
||||||
#### Example response
|
## Example response
|
||||||
|
|
||||||
The `POST /books,hockey/_cache/clear` request returns the following fields:
|
The `POST /books,hockey/_cache/clear` request returns the following fields:
|
||||||
|
|
||||||
|
@ -107,7 +107,7 @@ The `POST /books,hockey/_cache/clear` request returns the following fields:
|
||||||
}
|
}
|
||||||
````
|
````
|
||||||
|
|
||||||
### Response fields
|
## Response fields
|
||||||
|
|
||||||
The `POST /books,hockey/_cache/clear` request returns the following response fields:
|
The `POST /books,hockey/_cache/clear` request returns the following response fields:
|
||||||
|
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
layout: default
|
layout: default
|
||||||
title: Clone index
|
title: Clone index
|
||||||
parent: Index APIs
|
parent: Index APIs
|
||||||
nav_order: 70
|
nav_order: 15
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /opensearch/rest-api/index-apis/clone/
|
- /opensearch/rest-api/index-apis/clone/
|
||||||
---
|
---
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
layout: default
|
layout: default
|
||||||
title: Close index
|
title: Close index
|
||||||
parent: Index APIs
|
parent: Index APIs
|
||||||
nav_order: 30
|
nav_order: 20
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /opensearch/rest-api/index-apis/close-index/
|
- /opensearch/rest-api/index-apis/close-index/
|
||||||
---
|
---
|
||||||
|
@ -32,10 +32,10 @@ All parameters are optional.
|
||||||
|
|
||||||
Parameter | Type | Description
|
Parameter | Type | Description
|
||||||
:--- | :--- | :---
|
:--- | :--- | :---
|
||||||
<index-name> | String | The index to close. Can be a comma-separated list of multiple index names. Use `_all` or * to close all indices.
|
<index-name> | String | The index to close. Can be a comma-separated list of multiple index names. Use `_all` or * to close all indexes.
|
||||||
allow_no_indices | Boolean | Whether to ignore wildcards that don't match any indices. Default is true.
|
allow_no_indices | Boolean | Whether to ignore wildcards that don't match any indexes. Default is true.
|
||||||
expand_wildcards | String | Expands wildcard expressions to different indices. Combine multiple values with commas. Available values are all (match all indices), open (match open indices), closed (match closed indices), hidden (match hidden indices), and none (do not accept wildcard expressions). Default is open.
|
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). Default is open.
|
||||||
ignore_unavailable | Boolean | If true, OpenSearch does not search for missing or closed indices. Default is false.
|
ignore_unavailable | Boolean | If true, OpenSearch does not search for missing or closed indexes. Default is false.
|
||||||
wait_for_active_shards | String | Specifies the number of active shards that must be available before OpenSearch processes the request. Default is 1 (only the primary shard). Set to all or a positive integer. Values greater than 1 require replicas. For example, if you specify a value of 3, the index must have two replicas distributed across two additional nodes for the request to succeed.
|
wait_for_active_shards | String | Specifies the number of active shards that must be available before OpenSearch processes the request. Default is 1 (only the primary shard). Set to all or a positive integer. Values greater than 1 require replicas. For example, if you specify a value of 3, the index must have two replicas distributed across two additional nodes for the request to succeed.
|
||||||
master_timeout | Time | How long to wait for a connection to the master node. Default is `30s`.
|
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 response from the cluster. Default is `30s`.
|
timeout | Time | How long to wait for a response from the cluster. Default is `30s`.
|
||||||
|
|
|
@ -2,10 +2,10 @@
|
||||||
layout: default
|
layout: default
|
||||||
title: Create index
|
title: Create index
|
||||||
parent: Index APIs
|
parent: Index APIs
|
||||||
nav_order: 1
|
nav_order: 25
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /opensearch/rest-api/index-apis/create-index/
|
- /opensearch/rest-api/index-apis/create-index/
|
||||||
- opensearch/rest-api/create-index/
|
- /opensearch/rest-api/create-index/
|
||||||
---
|
---
|
||||||
|
|
||||||
# Create index
|
# Create index
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
layout: default
|
layout: default
|
||||||
title: Dangling indexes
|
title: Dangling indexes
|
||||||
parent: index-apis
|
parent: index-apis
|
||||||
nav_order: 84
|
nav_order: 30
|
||||||
---
|
---
|
||||||
|
|
||||||
# Dangling indexes API
|
# Dangling indexes API
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
layout: default
|
layout: default
|
||||||
title: Delete index
|
title: Delete index
|
||||||
parent: Index APIs
|
parent: Index APIs
|
||||||
nav_order: 10
|
nav_order: 35
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /opensearch/rest-api/index-apis/delete-index/
|
- /opensearch/rest-api/index-apis/delete-index/
|
||||||
---
|
---
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
layout: default
|
layout: default
|
||||||
title: Index exists
|
title: Index exists
|
||||||
parent: Index APIs
|
parent: Index APIs
|
||||||
nav_order: 5
|
nav_order: 50
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /opensearch/rest-api/index-apis/exists/
|
- /opensearch/rest-api/index-apis/exists/
|
||||||
---
|
---
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
layout: default
|
layout: default
|
||||||
title: Get index
|
title: Get index
|
||||||
parent: Index APIs
|
parent: Index APIs
|
||||||
nav_order: 20
|
nav_order: 40
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /opensearch/rest-api/index-apis/get-index/
|
- /opensearch/rest-api/index-apis/get-index/
|
||||||
---
|
---
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
layout: default
|
layout: default
|
||||||
title: Get settings
|
title: Get settings
|
||||||
parent: Index APIs
|
parent: Index APIs
|
||||||
nav_order: 100
|
nav_order: 45
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /opensearch/rest-api/index-apis/get-index/
|
- /opensearch/rest-api/index-apis/get-index/
|
||||||
---
|
---
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
layout: default
|
layout: default
|
||||||
title: Open index
|
title: Open index
|
||||||
parent: Index APIs
|
parent: Index APIs
|
||||||
nav_order: 40
|
nav_order: 55
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /opensearch/rest-api/index-apis/open-index/
|
- /opensearch/rest-api/index-apis/open-index/
|
||||||
---
|
---
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
layout: default
|
layout: default
|
||||||
title: Create or update mappings
|
title: Create or update mappings
|
||||||
parent: Index APIs
|
parent: Index APIs
|
||||||
nav_order: 220
|
nav_order: 27
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /opensearch/rest-api/index-apis/update-mapping/
|
- /opensearch/rest-api/index-apis/update-mapping/
|
||||||
---
|
---
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
layout: default
|
layout: default
|
||||||
title: Shrink index
|
title: Shrink index
|
||||||
parent: Index APIs
|
parent: Index APIs
|
||||||
nav_order: 50
|
nav_order: 65
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /opensearch/rest-api/index-apis/shrink-index/
|
- /opensearch/rest-api/index-apis/shrink-index/
|
||||||
---
|
---
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
layout: default
|
layout: default
|
||||||
title: Split index
|
title: Split index
|
||||||
parent: Index APIs
|
parent: Index APIs
|
||||||
nav_order: 80
|
nav_order: 70
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /opensearch/rest-api/index-apis/split/
|
- /opensearch/rest-api/index-apis/split/
|
||||||
---
|
---
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
layout: default
|
layout: default
|
||||||
title: Update settings
|
title: Update settings
|
||||||
parent: Index APIs
|
parent: Index APIs
|
||||||
nav_order: 120
|
nav_order: 75
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /opensearch/rest-api/index-apis/update-settings/
|
- /opensearch/rest-api/index-apis/update-settings/
|
||||||
---
|
---
|
||||||
|
|
Loading…
Reference in New Issue