You are looking at preliminary documentation for a future release.
Not what you want? See the
current release documentation.
Get lifecycle policy APIedit
Retrieves a lifecycle policy.
Prerequisitesedit
-
If the Elasticsearch security features are enabled, you must have the
manage_ilmorread_ilmor both cluster privileges to use this API. For more information, see Security privileges.
Descriptionedit
Returns the specified policy definition. Includes the policy version and last modified date. If no policy is specified, returns all defined policies.
Path parametersedit
-
<policy_id> - (Optional, string) Identifier for the policy.
Query parametersedit
-
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.
Examplesedit
The following example retrieves my_policy:
response = client.ilm.get_lifecycle( policy: 'my_policy' ) puts response
GET _ilm/policy/my_policy
If the request succeeds, the body of the response contains the policy definition:
{
"my_policy": {
"version": 1,
"modified_date": 82392349,
"policy": {
"phases": {
"warm": {
"min_age": "10d",
"actions": {
"forcemerge": {
"max_num_segments": 1
}
}
},
"delete": {
"min_age": "30d",
"actions": {
"delete": {
"delete_searchable_snapshot": true
}
}
}
}
},
"in_use_by" : {
"indices" : [],
"data_streams" : [],
"composable_templates" : []
}
}
}