This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
Retry policy execution API
editRetry policy execution API
editRetry executing the lifecycle policy for an index that is in the ERROR step.
Request
editPOST <index>/_ilm/retry
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have the
manage_ilmprivileges on the indices being managed to use this API. For more information, see Security privileges.
Description
editSets the policy back to the step where the error occurred and executes the step. Use the ILM Explain API to determine if an index is in the ERROR step.
Path parameters
edit-
<index> - (Required, string) Identifier for the indices to retry in comma-separated format.
Query parameters
edit-
master_timeout -
(Optional, time units)
Period to wait for the master node. If the master node is not available before
the timeout expires, the request fails and returns an error. Defaults to
30s. Can also be set to-1to indicate that the request should never timeout. -
timeout -
(Optional, time units) Period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.
If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.
Defaults to
30s. Can also be set to-1to indicate that the request should never timeout.
Examples
editThe following example retries the policy for my-index-000001.
POST my-index-000001/_ilm/retry
If the request succeeds, you receive the following result:
{
"acknowledged": true
}