Alibaba Cloud Elasticsearch provides a default index lifecycle template in the Scenario-based Configuration section of the Cluster Configuration page in the Elasticsearch console. This template enables you to modify the index lifecycle configurations of an Elasticsearch cluster that uses the hot-warm architecture. This template is available in the Elasticsearch console only if your Elasticsearch cluster is of V6.7.0 or later and contains warm nodes. This topic describes the parameters in the template.

For more information about how to modify the index lifecycle configurations of a cluster, see Use a scenario-based template to modify the configurations of a cluster. The following table describes the parameters in the template.
Notice
  • The policy defined in the default index lifecycle template is named aliyun_default_ilm_policy. By default, this policy is applied to the default index template aliyun_default_index_template. You can use Elasticsearch APIs to query the templates and policy. For more information, see Getting templates and Get lifecycle policy API.
  • You can configure other index lifecycle settings for your cluster even if the default index lifecycle template is applied.
  • The default index lifecycle template is unavailable if your cluster is of a version earlier than V6.7.0 or is of V6.7.0 or later but does not contain warm nodes. If you want to manage the index lifecycle of a cluster whose version is earlier than V6.7.0 or a cluster that is of V6.7.0 or later but does not contain warm nodes, you can use the index lifecycle management (ILM) feature. For more information about this feature, see Elasticsearch ILM.
Parameter Description
phases.hot.min_age The time that is required for an index to enter the hot phase.
phases.hot.actions.set_priority.priority The priority of an index in the hot phase.
phases.warm.min_age The time that is required for an index to enter the warm phase.
phases.warm.actions.allocate.number_of_replicas The number of replica shards for an index in the warm phase.
phases.warm.actions.allocate.require.box_type The shard allocation policy in the warm phase. For example, the system allocates shards to warm nodes.
phases.warm.actions.set_priority.priority The priority of an index in the warm phase.
phases.cold.min_age The time that is required for an index to enter the cold phase.
phases.cold.actions.set_priority.priority The priority of an index in the cold phase.