原文地址: https://www.elastic.co/guide/en/elasticsearch/reference/7.7/ilm-get-lifecycle.html, 原文档版权归 www.elastic.co 所有
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
Elasticsearch Guide [7.7] » REST APIs » Index lifecycle management API » Get lifecycle policy API
« Create lifecycle policy API Delete lifecycle policy API »

Get lifecycle policy APIedit

Retrieves a lifecycle policy.

Requestedit

GET _ilm/policy

GET _ilm/policy/<policy_id>

Prerequisitesedit

  • If the Elasticsearch security features are enabled, you must have the manage_ilm or read_ilm or 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) 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.
timeout
(Optional, 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.

Examplesedit

The following example retrieves my_policy:

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": {}
          }
        }
      }
    }
  }
}

The policy version is incremented whenever the policy is updated

When this policy was last modified
« Create lifecycle policy API Delete lifecycle policy API »