retry-policy.asciidoc 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[ilm-retry-policy]]
  4. === Retry policy execution API
  5. ++++
  6. <titleabbrev>Retry policy</titleabbrev>
  7. ++++
  8. Retry executing the policy for an index that is in the ERROR step.
  9. ==== Request
  10. `POST <index>/_ilm/retry`
  11. ==== Description
  12. Sets the policy back to the step where the error occurred and executes the step.
  13. Use the <<ilm-explain-lifecycle, ILM Explain API>> to determine if an index is in the ERROR
  14. step.
  15. ==== Path Parameters
  16. `index` (required)::
  17. (string) Identifier for the indices to retry in comma-separated format.
  18. ==== Request Parameters
  19. include::{docdir}/rest-api/timeoutparms.asciidoc[]
  20. ==== Authorization
  21. You must have the `manage_ilm` privileges on the indices being managed to use this API.
  22. For more information, see {stack-ov}/security-privileges.html[Security Privileges].
  23. ==== Examples
  24. The following example retries the policy for `my_index`.
  25. [source,js]
  26. --------------------------------------------------
  27. POST my_index/_ilm/retry
  28. --------------------------------------------------
  29. // NOTCONSOLE
  30. If the request succeeds, you receive the following result:
  31. [source,js]
  32. --------------------------------------------------
  33. {
  34. "acknowledged": true
  35. }
  36. --------------------------------------------------
  37. // NOTCONSOLE