Files
elasticsearch-js/docs/reference-ilm-migrate_to_data_tiers.asciidoc
2024-12-05 14:46:52 -06:00

82 lines
4.4 KiB
Plaintext

[[reference-ilm-migrate_to_data_tiers]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
[discrete]
[[client.ilm.migrateToDataTiers]]
=== client.ilm.migrateToDataTiers
Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+ Using node roles enables ILM to automatically move the indices between data tiers.
{ref}/ilm-migrate-to-data-tiers.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(IlmMigrateToDataTiersRequest, options?): Promise<IlmMigrateToDataTiersResponse>
----
[discrete]
==== Request
[pass]
++++
<pre>
++++
interface IlmMigrateToDataTiersRequest extends <<RequestBase>> {
dry_run?: boolean
legacy_template_to_delete?: string
node_attribute?: string
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
[pass]
++++
<pre>
++++
interface IlmMigrateToDataTiersResponse {
dry_run: boolean
removed_legacy_template: string
migrated_ilm_policies: string[]
migrated_indices: <<Indices>>
migrated_legacy_templates: string[]
migrated_composable_templates: string[]
migrated_component_templates: string[]
}
[pass]
++++
</pre>
++++