Skip to content

Commit 5229e64

Browse files
authored
[+DOC] ILM Move Step example only phase
Updates [doc](https://www.elastic.co/guide/en/elasticsearch/reference/master/ilm-move-to-step.html?edit) to append example similar to #75435 (≥v7.15.0) to show users working example of only using `next_step.phase`.
1 parent f2a1ee9 commit 5229e64

File tree

1 file changed

+22
-4
lines changed

1 file changed

+22
-4
lines changed

docs/reference/ilm/apis/move-to-step.asciidoc

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -95,12 +95,12 @@ For more information, see <<index-lifecycle-error-handling, {ilm-init} error han
9595
The name of the phase that contains the action you want to perform or resume.
9696
9797
`action`::
98-
(Required, string)
99-
The name action you want to perform or resume.
98+
(Optional, string)
99+
The name action you want to perform or resume. Required if `name` used.
100100
101101
`name`::
102-
(Required, string)
103-
The name of the step to move to and execute.
102+
(Optional, string)
103+
The name of the step to move to and execute. Required if `action` used.
104104
105105
====
106106

@@ -168,6 +168,24 @@ POST _ilm/move/my-index-000001
168168
<3> The optional action to which the index will be moved
169169
<4> The optional step name to which the index will be moved
170170

171+
Alternatively, the following example pushes `my-index-000001`
172+
from the end of hot phase into the start of warm:
173+
174+
[source,console]
175+
--------------------------------------------------
176+
POST _ilm/move/my-index-000001
177+
{
178+
"current_step": {
179+
"phase": "hot",
180+
"action": "complete",
181+
"name": "complete"
182+
},
183+
"next_step": {
184+
"phase": "warm"
185+
}
186+
}
187+
--------------------------------------------------
188+
171189
If the request succeeds, you receive the following result:
172190

173191
[source,console-result]

0 commit comments

Comments
 (0)