mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-07 05:28:34 +00:00
29ef442841
This commit adds a rest endpoint for freezing and unfreezing an index. Among other cleanups mainly fixing an issue accessing package private APIs from a plugin that got caught by integration tests this change also adds documentation for frozen indices. Note: frozen indices are marked as `beta` and available as a basic feature. Relates to #34352
51 lines
1.1 KiB
Plaintext
51 lines
1.1 KiB
Plaintext
[role="xpack"]
|
|
[testenv="basic"]
|
|
[[unfreeze-index-api]]
|
|
== Unfreeze Index API
|
|
++++
|
|
<titleabbrev>Unfreeze Index</titleabbrev>
|
|
++++
|
|
|
|
Unfreezes an index.
|
|
|
|
[float]
|
|
=== Request
|
|
|
|
`POST /<index>/_unfreeze`
|
|
|
|
[float]
|
|
=== Description
|
|
|
|
When a frozen index is unfrozen, the index goes through the normal recovery
|
|
process and becomes writeable again. See <<frozen-indices>> and <<freeze-index-api>>.
|
|
|
|
[float]
|
|
=== Path Parameters
|
|
|
|
`index` (required)::
|
|
(string) Identifier for the index
|
|
|
|
|
|
//=== Query Parameters
|
|
|
|
//=== Authorization
|
|
|
|
[float]
|
|
=== Examples
|
|
|
|
The following example freezes and unfreezes an index:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
POST /my_index/_freeze
|
|
POST /my_index/_unfreeze
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[s/^/PUT my_index\n/]
|
|
|
|
[IMPORTANT]
|
|
================================
|
|
Freezing an index will close the index and reopen it within the same API call. This causes primaries to not be allocated for a short
|
|
amount of time and causes the cluster to go red until the primaries are allocated again. This limitation might be removed in the future.
|
|
================================
|