mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-30 10:23:41 -04:00
c1019d4c5d
* (Doc+) Link API to parent Doc part1 --------- Co-authored-by: shainaraskas <shaina.raskas@elastic.co> Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
87 lines
1.8 KiB
Text
87 lines
1.8 KiB
Text
[role="xpack"]
|
|
[[ilm-start]]
|
|
=== Start {ilm} API
|
|
|
|
[subs="attributes"]
|
|
++++
|
|
<titleabbrev>Start {ilm}</titleabbrev>
|
|
++++
|
|
|
|
Start the <<index-lifecycle-management,{ilm}>> ({ilm-init}) plugin.
|
|
|
|
[[ilm-start-request]]
|
|
==== {api-request-title}
|
|
|
|
`POST /_ilm/start`
|
|
|
|
[[ilm-start-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* If the {es} {security-features} are enabled, you must have the `manage_ilm`
|
|
cluster privilege to use this API. For more information, see
|
|
<<security-privileges>>.
|
|
|
|
[[ilm-start-desc]]
|
|
==== {api-description-title}
|
|
|
|
Starts the {ilm-init} plugin if it is currently stopped. {ilm-init} is started
|
|
automatically when the cluster is formed. Restarting {ilm-init} is only
|
|
necessary if it has been stopped using the <<ilm-stop, Stop {ilm-init} API>>.
|
|
|
|
[[ilm-start-query-params]]
|
|
==== {api-query-parms-title}
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
|
|
|
[[ilm-start-example]]
|
|
==== {api-examples-title}
|
|
|
|
The following example starts the {ilm-init} plugin.
|
|
|
|
//////////////////////////
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
PUT _ilm/policy/my_policy
|
|
{
|
|
"policy": {
|
|
"phases": {
|
|
"warm": {
|
|
"min_age": "10d",
|
|
"actions": {
|
|
"forcemerge": {
|
|
"max_num_segments": 1
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"min_age": "30d",
|
|
"actions": {
|
|
"delete": {}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
PUT my-index-000001
|
|
|
|
POST _ilm/stop
|
|
--------------------------------------------------
|
|
|
|
//////////////////////////
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
POST _ilm/start
|
|
--------------------------------------------------
|
|
// TEST[continued]
|
|
|
|
If the request succeeds, you receive the following result:
|
|
|
|
[source,console-result]
|
|
--------------------------------------------------
|
|
{
|
|
"acknowledged": true
|
|
}
|
|
--------------------------------------------------
|