2018-11-26 11:15:54 -05:00
|
|
|
[role="xpack"]
|
|
|
|
[testenv="platinum"]
|
|
|
|
[[ml-delete-expired-data]]
|
2018-12-20 13:23:28 -05:00
|
|
|
=== Delete expired data API
|
2018-11-26 11:15:54 -05:00
|
|
|
++++
|
2018-12-20 13:23:28 -05:00
|
|
|
<titleabbrev>Delete expired data</titleabbrev>
|
2018-11-26 11:15:54 -05:00
|
|
|
++++
|
|
|
|
|
|
|
|
Deletes expired and unused machine learning data.
|
|
|
|
|
2019-06-27 12:42:47 -04:00
|
|
|
[[ml-delete-expired-data-request]]
|
|
|
|
==== {api-request-title}
|
2018-11-26 11:15:54 -05:00
|
|
|
|
2018-12-07 15:34:11 -05:00
|
|
|
`DELETE _ml/_delete_expired_data`
|
2018-11-26 11:15:54 -05:00
|
|
|
|
2019-06-27 16:58:42 -04:00
|
|
|
[[ml-delete-expired-data-prereqs]]
|
|
|
|
==== {api-prereq-title}
|
|
|
|
|
|
|
|
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
|
|
|
`manage` cluster privileges to use this API. See
|
2019-10-07 18:23:19 -04:00
|
|
|
<<security-privileges>>.
|
2019-06-27 16:58:42 -04:00
|
|
|
|
2019-06-27 12:42:47 -04:00
|
|
|
[[ml-delete-expired-data-desc]]
|
|
|
|
==== {api-description-title}
|
2018-11-26 11:15:54 -05:00
|
|
|
|
2018-12-20 13:23:28 -05:00
|
|
|
Deletes all job results, model snapshots and forecast data that have exceeded
|
|
|
|
their `retention days` period. Machine learning state documents that are not
|
|
|
|
associated with any job are also deleted.
|
2018-11-26 11:15:54 -05:00
|
|
|
|
2020-05-18 08:46:42 -04:00
|
|
|
[[ml-delete-expired-data-request-body]]
|
|
|
|
==== {api-request-body-title}
|
|
|
|
|
|
|
|
`requests_per_second`::
|
|
|
|
(Optional, float) The desired requests per second for the deletion processes.
|
|
|
|
The default behavior is no throttling.
|
|
|
|
|
|
|
|
`timeout`::
|
|
|
|
(Optional, string) How long can the underlying delete processes run until they are canceled.
|
|
|
|
The default value is `8h` (8 hours).
|
|
|
|
|
2019-06-27 12:42:47 -04:00
|
|
|
[[ml-delete-expired-data-example]]
|
|
|
|
==== {api-examples-title}
|
2018-11-26 11:15:54 -05:00
|
|
|
|
|
|
|
The endpoint takes no arguments:
|
|
|
|
|
2019-09-06 11:31:13 -04:00
|
|
|
[source,console]
|
2018-11-26 11:15:54 -05:00
|
|
|
--------------------------------------------------
|
2018-12-07 15:34:11 -05:00
|
|
|
DELETE _ml/_delete_expired_data
|
2018-11-26 11:15:54 -05:00
|
|
|
--------------------------------------------------
|
|
|
|
// TEST
|
|
|
|
|
|
|
|
When the expired data is deleted, you receive the following response:
|
2019-09-06 09:22:08 -04:00
|
|
|
|
|
|
|
[source,console-result]
|
2018-11-26 11:15:54 -05:00
|
|
|
----
|
|
|
|
{
|
|
|
|
"deleted": true
|
|
|
|
}
|
|
|
|
----
|