66 lines
2.3 KiB
Plaintext
66 lines
2.3 KiB
Plaintext
|
--
|
||
|
|
:api: freeze-index
|
||
|
|
:request: FreezeIndexRequest
|
||
|
|
:response: FreezeIndexResponse
|
||
|
|
--
|
||
|
|
|
||
|
|
[id="{upid}-{api}"]
|
||
|
|
=== Freeze Index API
|
||
|
|
|
||
|
|
[id="{upid}-{api}-request"]
|
||
|
|
==== Freeze Index Request
|
||
|
|
|
||
|
|
An +{request}+ requires an `index` argument:
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
--------------------------------------------------
|
||
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
||
|
|
--------------------------------------------------
|
||
|
|
<1> The index to freeze
|
||
|
|
|
||
|
|
==== Optional arguments
|
||
|
|
The following arguments can optionally be provided:
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
--------------------------------------------------
|
||
|
|
include-tagged::{doc-tests-file}[{api}-request-timeout]
|
||
|
|
--------------------------------------------------
|
||
|
|
<1> Timeout to wait for the all the nodes to acknowledge the index is frozen
|
||
|
|
as a `TimeValue`
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
--------------------------------------------------
|
||
|
|
include-tagged::{doc-tests-file}[{api}-request-masterTimeout]
|
||
|
|
--------------------------------------------------
|
||
|
|
<1> Timeout to connect to the master node as a `TimeValue`
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
--------------------------------------------------
|
||
|
|
include-tagged::{doc-tests-file}[{api}-request-waitForActiveShards]
|
||
|
|
--------------------------------------------------
|
||
|
|
<1> The number of active shard copies to wait for before the freeze index API
|
||
|
|
returns a response, as an `ActiveShardCount`
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
--------------------------------------------------
|
||
|
|
include-tagged::{doc-tests-file}[{api}-request-indicesOptions]
|
||
|
|
--------------------------------------------------
|
||
|
|
<1> Setting `IndicesOptions` controls how unavailable indices are resolved and
|
||
|
|
how wildcard expressions are expanded
|
||
|
|
|
||
|
|
include::../execution.asciidoc[]
|
||
|
|
|
||
|
|
[id="{upid}-{api}-response"]
|
||
|
|
==== Freeze Index Response
|
||
|
|
|
||
|
|
The returned +{response}+ allows to retrieve information about the
|
||
|
|
executed operation as follows:
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
--------------------------------------------------
|
||
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
||
|
|
--------------------------------------------------
|
||
|
|
<1> Indicates whether all of the nodes have acknowledged the request
|
||
|
|
<2> Indicates whether the requisite number of shard copies were started for
|
||
|
|
each shard in the index before timing out
|