retry-policy.asciidoc 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[ilm-retry-policy]]
  4. === Retry Policy Execution API
  5. ++++
  6. <titleabbrev>Retry Policy Execution</titleabbrev>
  7. ++++
  8. Retry executing the policy for an index which has errored.
  9. ==== Request
  10. `POST <index>/_ilm/retry`
  11. ==== Description
  12. This API will re-run a policy is currently in the ERROR step. It will set the
  13. policy back to the step where the error occurred and attempt to re-execute it.
  14. Information on whether an index is in the ERROR step can be obtained from the
  15. <<ilm-explain, ILM Explain API>>
  16. ==== Path Parameters
  17. `index` (required)::
  18. (string) Identifier for the indices to retry in comma-separated format.
  19. ==== Request Parameters
  20. `timeout`::
  21. (time units) Specifies the period of time to wait for the completion of the
  22. retry operation. When this period of time elapses, the API fails and returns
  23. an error. The default value is `30s`. For more information about time units,
  24. see <<time-units>>.
  25. `master_timeout`::
  26. (time units) Specifies the period of time to wait for the connection with master.
  27. When this period of time elapses, the API fails and returns an error.
  28. The default value is `30s`. For more information about time units, see <<time-units>>.
  29. ==== Examples
  30. The following example retries the policy for index `my_index`.
  31. [source,js]
  32. --------------------------------------------------
  33. POST my_index/_ilm/retry
  34. --------------------------------------------------
  35. // NOTCONSOLE
  36. If the request does not encounter errors, you receive the following result:
  37. [source,js]
  38. --------------------------------------------------
  39. {
  40. "acknowledged": true
  41. }
  42. --------------------------------------------------
  43. // NOTCONSOLE