2018-11-20 02:03:24 -05:00
|
|
|
[role="xpack"]
|
|
|
|
[testenv="basic"]
|
|
|
|
[[unfreeze-index-api]]
|
2019-07-08 11:56:30 -04:00
|
|
|
=== Unfreeze index API
|
2018-11-20 02:03:24 -05:00
|
|
|
++++
|
2018-12-20 13:23:28 -05:00
|
|
|
<titleabbrev>Unfreeze index</titleabbrev>
|
2018-11-20 02:03:24 -05:00
|
|
|
++++
|
|
|
|
|
|
|
|
Unfreezes an index.
|
|
|
|
|
2019-07-08 11:56:30 -04:00
|
|
|
[[unfreeze-index-api-request]]
|
|
|
|
==== {api-request-title}
|
2018-11-20 02:03:24 -05:00
|
|
|
|
|
|
|
`POST /<index>/_unfreeze`
|
|
|
|
|
2019-07-08 11:56:30 -04:00
|
|
|
//[[unfreeze-index-api-prereqs]]
|
|
|
|
//==== {api-prereq-title}
|
|
|
|
|
|
|
|
[[unfreeze-index-api-desc]]
|
|
|
|
==== {api-description-title}
|
2018-11-20 02:03:24 -05:00
|
|
|
|
|
|
|
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>>.
|
|
|
|
|
2019-07-08 11:56:30 -04:00
|
|
|
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.
|
2018-11-20 02:03:24 -05:00
|
|
|
|
2019-07-08 11:56:30 -04:00
|
|
|
[[unfreeze-index-api-path-parms]]
|
|
|
|
==== {api-path-parms-title}
|
2018-11-20 02:03:24 -05:00
|
|
|
|
2019-07-12 11:26:31 -04:00
|
|
|
`<index>`::
|
|
|
|
(Required, string) Identifier for the index.
|
2018-11-20 02:03:24 -05:00
|
|
|
|
2019-07-08 11:56:30 -04:00
|
|
|
[[unfreeze-index-api-examples]]
|
|
|
|
==== {api-examples-title}
|
2018-11-20 02:03:24 -05:00
|
|
|
|
|
|
|
The following example freezes and unfreezes an index:
|
|
|
|
|
2019-09-06 11:31:13 -04:00
|
|
|
[source,console]
|
2018-11-20 02:03:24 -05:00
|
|
|
--------------------------------------------------
|
2020-07-27 15:58:26 -04:00
|
|
|
POST /my-index-000001/_freeze
|
|
|
|
POST /my-index-000001/_unfreeze
|
2018-11-20 02:03:24 -05:00
|
|
|
--------------------------------------------------
|
2020-07-27 15:58:26 -04:00
|
|
|
// TEST[s/^/PUT my-index-000001\n/]
|