Type to search.

Migrate to data tiers routing

  • POST /_ilm/migrate_to_data_tiers
Auth The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Generally available since 7.14 This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Switch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers. Optionally, delete one legacy index template. Using node roles enables ILM to automatically move the indices between data tiers.

Migrating away from custom node attributes routing can be manually performed. This API provides an automated way of performing three out of the four manual steps listed in the migration guide:

  1. Stop setting the custom hot attribute on new indices.
  2. Remove custom allocation settings from existing ILM policies.
  3. Replace custom allocation settings from existing indices with the corresponding tier preference.

ILM must be stopped before performing the migration. Use the stop ILM and get ILM status APIs to wait until the reported operation mode is STOPPED.

About migrating index allocation

Required privileges

Cluster privileges manage

Query parameters

dry_run boolean · default: false

If true, simulates the migration from node attributes based allocation filters to data tiers, but does not perform the migration. This provides a way to retrieve the indices and ILM policies that need to be migrated.

master_timeout union oneOf · default: 30s

The period 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. It can also be set to -1 to indicate that the request should never timeout.

Values: -1 0

Request body

legacy_template_to_delete string
node_attribute string

Response

application/json
dry_run boolean required
removed_legacy_template string required

The name of the legacy index template that was deleted. This information is missing if no legacy index templates were deleted.

migrated_ilm_policies string[] required

The ILM policies that were updated.

migrated_indices union oneOf required

The indices that were migrated to tier preference routing.

One of: string[] or string
migrated_legacy_templates string[] required

The legacy index templates that were updated to not contain custom routing settings for the provided data attribute.

migrated_composable_templates string[] required

The composable index templates that were updated to not contain custom routing settings for the provided data attribute.

migrated_component_templates string[] required

The component templates that were updated to not contain custom routing settings for the provided data attribute.