IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Retry policy execution API
editRetry policy execution API
editThis functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
Retry executing the policy for an index that is in the ERROR step.
Request
editPOST <index>/_ilm/retry
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.
Request Parameters
edit-
timeout -
(time units) Specifies the period of time to wait for a response. If no
response is received before the timeout expires, the request fails and
returns an error. Defaults to
30s. For more information about time units, see Time units. -
master_timeout -
(time units) Specifies the period of time to wait for a connection to the
master node. If no response is received before the timeout expires, the request
fails and returns an error. Defaults to
30s. For more information about time units, see Time units.
Authorization
editYou must have the manage_ilm privileges on the indices being managed to use this API.
For more information, see Security Privileges.
Examples
editThe following example retries the policy for my_index.
POST my_index/_ilm/retry
If the request succeeds, you receive the following result:
{
"acknowledged": true
}