2018-11-27 00:15:54 +08:00
|
|
|
[role="xpack"]
|
|
|
|
[testenv="platinum"]
|
|
|
|
[[ml-delete-expired-data]]
|
2018-12-21 02:23:28 +08:00
|
|
|
=== Delete expired data API
|
2018-11-27 00:15:54 +08:00
|
|
|
++++
|
2018-12-21 02:23:28 +08:00
|
|
|
<titleabbrev>Delete expired data</titleabbrev>
|
2018-11-27 00:15:54 +08:00
|
|
|
++++
|
|
|
|
|
|
|
|
Deletes expired and unused machine learning data.
|
|
|
|
|
2019-06-28 00:42:47 +08:00
|
|
|
[[ml-delete-expired-data-request]]
|
|
|
|
==== {api-request-title}
|
2018-11-27 00:15:54 +08:00
|
|
|
|
2018-12-08 04:34:11 +08:00
|
|
|
`DELETE _ml/_delete_expired_data`
|
2018-11-27 00:15:54 +08:00
|
|
|
|
2019-06-28 04:58:42 +08: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
|
|
|
|
{stack-ov}/security-privileges.html[Security privileges].
|
|
|
|
|
2019-06-28 00:42:47 +08:00
|
|
|
[[ml-delete-expired-data-desc]]
|
|
|
|
==== {api-description-title}
|
2018-11-27 00:15:54 +08:00
|
|
|
|
2018-12-21 02:23:28 +08: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-27 00:15:54 +08:00
|
|
|
|
2019-06-28 00:42:47 +08:00
|
|
|
[[ml-delete-expired-data-example]]
|
|
|
|
==== {api-examples-title}
|
2018-11-27 00:15:54 +08:00
|
|
|
|
|
|
|
The endpoint takes no arguments:
|
|
|
|
|
2019-09-06 22:55:16 +08:00
|
|
|
[source,console]
|
2018-11-27 00:15:54 +08:00
|
|
|
--------------------------------------------------
|
2018-12-08 04:34:11 +08:00
|
|
|
DELETE _ml/_delete_expired_data
|
2018-11-27 00:15:54 +08:00
|
|
|
--------------------------------------------------
|
|
|
|
// TEST
|
|
|
|
|
|
|
|
When the expired data is deleted, you receive the following response:
|
2019-09-06 04:47:18 +08:00
|
|
|
|
|
|
|
[source,console-result]
|
2018-11-27 00:15:54 +08:00
|
|
|
----
|
|
|
|
{
|
|
|
|
"deleted": true
|
|
|
|
}
|
|
|
|
----
|