mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-24 23:27:25 -04:00
f56a0f4b66
Removes `testenv` annotations and related code. These annotations originally let you skip x-pack snippet tests in the docs. However, that's no longer possible. Relates to #79309, #31619
181 lines
4.8 KiB
Text
181 lines
4.8 KiB
Text
[role="xpack"]
|
|
[[ilm-move-to-step]]
|
|
=== Move to lifecycle step API
|
|
++++
|
|
<titleabbrev>Move to step</titleabbrev>
|
|
++++
|
|
|
|
Triggers execution of a specific step in the lifecycle policy.
|
|
|
|
[[ilm-move-to-step-request]]
|
|
==== {api-request-title}
|
|
|
|
`POST _ilm/move/<index>`
|
|
|
|
[[ilm-move-to-step-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* If the {es} {security-features} are enabled, you must have the `manage_ilm`
|
|
privileges on the indices being managed to use this API. For more information,
|
|
see <<security-privileges>>.
|
|
|
|
[[ilm-move-to-step-desc]]
|
|
==== {api-description-title}
|
|
|
|
WARNING: This operation can result in the loss of data. Manually moving an index
|
|
into a specific step executes that step even if it has already been performed.
|
|
This is a potentially destructive action and this should be considered an expert
|
|
level API.
|
|
|
|
Manually moves an index into the specified step and executes that step.
|
|
You must specify both the current step and the step to be executed in the
|
|
body of the request.
|
|
|
|
The request will fail if the current step does not match the step currently
|
|
being executed for the index. This is to prevent the index from being moved from
|
|
an unexpected step into the next step.
|
|
|
|
When specifying the target (`next_step`) to which the index will be moved, either the `name` or both
|
|
the `action` and `name` fields are optional. If only the phase is specified, the index will move to
|
|
the first step of the first action in the target phase. If the phase and action are specified, the index will move to
|
|
the first step of the specified action in the specified phase. Only actions specified in the ILM
|
|
policy are considered valid, an index cannot move to a step that is not part of its policy.
|
|
|
|
[[ilm-move-to-step-path-params]]
|
|
==== {api-path-parms-title}
|
|
|
|
`<index>`::
|
|
(Required, string) Identifier for the index.
|
|
|
|
[[ilm-move-to-step-query-params]]
|
|
==== {api-query-parms-title}
|
|
|
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
|
|
|
[role="child_attributes"]
|
|
[[ilm-move-to-step-request-body]]
|
|
==== {api-request-body-title}
|
|
|
|
`current_step`::
|
|
(Required, object)
|
|
+
|
|
.Properties of `current_step`
|
|
[%collapsible%open]
|
|
====
|
|
`phase`::
|
|
(Required, string)
|
|
The name of the current phase.
|
|
Must match the phase as returned by the <<ilm-explain-lifecycle, explain>> API.
|
|
|
|
`action`::
|
|
(Required, string)
|
|
The name of the current action.
|
|
Must match the action as returned by the <<ilm-explain-lifecycle, explain>> API.
|
|
|
|
`name`::
|
|
(Required, string)
|
|
The name of the current step.
|
|
Must match the step as returned by the <<ilm-explain-lifecycle, explain>> API.
|
|
If {ilm-init} encounters a problem while performing an action,
|
|
it halts execution of the policy and transitions to the `ERROR` step.
|
|
If you are trying to advance a policy after troubleshooting a failure,
|
|
you specify this `ERROR` step as the current step.
|
|
For more information, see <<index-lifecycle-error-handling, {ilm-init} error handling>>.
|
|
|
|
====
|
|
|
|
`next_step`::
|
|
(Required, object)
|
|
+
|
|
.Properties of `next_step`
|
|
[%collapsible%open]
|
|
====
|
|
`phase`::
|
|
(Required, string)
|
|
The name of the phase that contains the action you want to perform or resume.
|
|
|
|
`action`::
|
|
(Required, string)
|
|
The name action you want to perform or resume.
|
|
|
|
`name`::
|
|
(Required, string)
|
|
The name of the step to move to and execute.
|
|
|
|
====
|
|
|
|
[[ilm-move-to-step-example]]
|
|
==== {api-examples-title}
|
|
|
|
The following example moves `my-index-000001` from the initial step to the
|
|
`forcemerge` step:
|
|
|
|
//////////////////////////
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
PUT _ilm/policy/my_policy
|
|
{
|
|
"policy": {
|
|
"phases": {
|
|
"warm": {
|
|
"min_age": "10d",
|
|
"actions": {
|
|
"forcemerge": {
|
|
"max_num_segments": 1
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"min_age": "30d",
|
|
"actions": {
|
|
"delete": {}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
PUT my-index-000001
|
|
{
|
|
"settings": {
|
|
"index.lifecycle.name": "my_policy"
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
|
|
//////////////////////////
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
POST _ilm/move/my-index-000001
|
|
{
|
|
"current_step": { <1>
|
|
"phase": "new",
|
|
"action": "complete",
|
|
"name": "complete"
|
|
},
|
|
"next_step": { <2>
|
|
"phase": "warm",
|
|
"action": "forcemerge", <3>
|
|
"name": "forcemerge" <4>
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
// TEST[continued]
|
|
<1> The step that the index is expected to be in
|
|
<2> The step that you want to execute
|
|
<3> The optional action to which the index will be moved
|
|
<4> The optional step name to which the index will be moved
|
|
|
|
If the request succeeds, you receive the following result:
|
|
|
|
[source,console-result]
|
|
--------------------------------------------------
|
|
{
|
|
"acknowledged": true
|
|
}
|
|
--------------------------------------------------
|
|
|
|
The request will fail if the index is not in the `new` phase as specified
|
|
by the `current_step`.
|