mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-04-26 17:15:47 +00:00
297f864884
Throttling nightly cleanup as much as we do has been over cautious. Night cleanup should be more lenient in its throttling. We still keep the same batch size, but now the requests per second scale with the number of data nodes. If we have more than 5 data nodes, we don't throttle at all. Additionally, the API now has `requests_per_second` and `timeout` set. So users calling the API directly can set the throttling. This commit also adds a new setting `xpack.ml.nightly_maintenance_requests_per_second`. This will allow users to adjust throttling of the nightly maintenance.
60 lines
1.5 KiB
Plaintext
60 lines
1.5 KiB
Plaintext
[role="xpack"]
|
|
[testenv="platinum"]
|
|
[[ml-delete-expired-data]]
|
|
=== Delete expired data API
|
|
++++
|
|
<titleabbrev>Delete expired data</titleabbrev>
|
|
++++
|
|
|
|
Deletes expired and unused machine learning data.
|
|
|
|
[[ml-delete-expired-data-request]]
|
|
==== {api-request-title}
|
|
|
|
`DELETE _ml/_delete_expired_data`
|
|
|
|
[[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
|
|
<<security-privileges>>.
|
|
|
|
[[ml-delete-expired-data-desc]]
|
|
==== {api-description-title}
|
|
|
|
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.
|
|
|
|
[[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).
|
|
|
|
[[ml-delete-expired-data-example]]
|
|
==== {api-examples-title}
|
|
|
|
The endpoint takes no arguments:
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
DELETE _ml/_delete_expired_data
|
|
--------------------------------------------------
|
|
// TEST
|
|
|
|
When the expired data is deleted, you receive the following response:
|
|
|
|
[source,console-result]
|
|
----
|
|
{
|
|
"deleted": true
|
|
}
|
|
----
|