@@ -47,6 +47,58 @@ an unexpected step into the next step.
47
47
48
48
include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
49
49
50
+ [role="child_attributes"]
51
+ [[ilm-move-to-step-request-body]]
52
+ ==== {api-request-body-title}
53
+
54
+ `current_step`::
55
+ (Required, object)
56
+ +
57
+ .Properties of `current_step`
58
+ [%collapsible%open]
59
+ ====
60
+ `phase`::
61
+ (Required, string)
62
+ The name of the current phase.
63
+ Must match the phase as returned by the <<ilm-explain-lifecycle, explain>> API.
64
+
65
+ `action`::
66
+ (Required, string)
67
+ The name of the current action.
68
+ Must match the action as returned by the <<ilm-explain-lifecycle, explain>> API.
69
+
70
+ `name`::
71
+ (Required, string)
72
+ The name of the current step.
73
+ Must match the step as returned by the <<ilm-explain-lifecycle, explain>> API.
74
+ If {ilm-init} encounters a problem while performing an action,
75
+ it halts execution of the policy and transitions to the `ERROR` step.
76
+ If you are trying to advance a policy after troubleshooting a failure,
77
+ you specify this `ERROR` step as the current step.
78
+ For more information, see <<index-lifecycle-error-handling, {ilm-init} error handling>>.
79
+
80
+ ====
81
+
82
+ `next_step`::
83
+ (Required, object)
84
+ +
85
+ .Properties of `next_step`
86
+ [%collapsible%open]
87
+ ====
88
+ `phase`::
89
+ (Required, string)
90
+ The name of the phase that contains the action you want to perform or resume.
91
+
92
+ `action`::
93
+ (Required, string)
94
+ The name action you want to perform or resume.
95
+
96
+ `name`::
97
+ (Required, string)
98
+ The name of the step to move to and execute.
99
+
100
+ ====
101
+
50
102
[[ilm-move-to-step-example]]
51
103
==== {api-examples-title}
52
104
0 commit comments