honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference/indices/apis/freeze.asciidoc

50 lines
1.2 KiB
Plaintext
Raw Normal View History

Add a `_freeze` / `_unfreeze` API (#35592) 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
2018-11-20 02:03:24 -05:00
[role="xpack"]
[testenv="basic"]
[[freeze-index-api]]
[DOCS] Reformat freeze unfreeze APis to use new API format (#43948)
2019-07-08 11:56:30 -04:00
=== Freeze index API
Add a `_freeze` / `_unfreeze` API (#35592) 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
2018-11-20 02:03:24 -05:00
++++
[DOCS] Synchs titles of X-Pack APIs
2018-12-20 13:23:28 -05:00
<titleabbrev>Freeze index</titleabbrev>
Add a `_freeze` / `_unfreeze` API (#35592) 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
2018-11-20 02:03:24 -05:00
++++
Freezes an index.
[DOCS] Reformat freeze unfreeze APis to use new API format (#43948)
2019-07-08 11:56:30 -04:00
[[freeze-index-api-request]]
==== {api-request-title}
Add a `_freeze` / `_unfreeze` API (#35592) 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
2018-11-20 02:03:24 -05:00
`POST /<index>/_freeze`
[DOCS] Reformat freeze unfreeze APis to use new API format (#43948)
2019-07-08 11:56:30 -04:00
//[[freeze-index-api-prereqs]]
//==== {api-prereq-title}
[[freeze-index-api-desc]]
==== {api-description-title}
Add a `_freeze` / `_unfreeze` API (#35592) 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
2018-11-20 02:03:24 -05:00
A frozen index has almost no overhead on the cluster (except
for maintaining its metadata in memory), and is blocked for write operations.
See <<frozen-indices>> and <<unfreeze-index-api>>.
[DOCS] Reformat freeze unfreeze APis to use new API format (#43948)
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.
Add a `_freeze` / `_unfreeze` API (#35592) 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
2018-11-20 02:03:24 -05:00
[DOCS] Reformat freeze unfreeze APis to use new API format (#43948)
2019-07-08 11:56:30 -04:00
[[freeze-index-api-path-parms]]
==== {api-path-parms-title}
Add a `_freeze` / `_unfreeze` API (#35592) 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
2018-11-20 02:03:24 -05:00
[DOCS] Reformats API parameter details (#44194)
2019-07-12 11:26:31 -04:00
`<index>`::
(Required, string) Identifier for the index.
Add a `_freeze` / `_unfreeze` API (#35592) 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
2018-11-20 02:03:24 -05:00
[DOCS] Reformat freeze unfreeze APis to use new API format (#43948)
2019-07-08 11:56:30 -04:00
[[freeze-index-api-examples]]
==== {api-examples-title}
Add a `_freeze` / `_unfreeze` API (#35592) 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
2018-11-20 02:03:24 -05:00
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/]