mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-07 05:28:34 +00:00
4dacfa95d2
This changes the delete job API by adding the choice to delete a job asynchronously. The commit adds a `wait_for_completion` parameter to the delete job request. When set to `false`, the action returns immediately and the response contains the task id. This also changes the handling of subsequent delete requests for a job that is already being deleted. It now uses the task framework to check if the job is being deleted instead of the cluster state. This is a beneficial for it is going to also be working once the job configs are moved out of the cluster state and into an index. Also, force delete requests that are waiting for the job to be deleted will not proceed with the deletion if the first task fails. This will prevent overloading the cluster. Instead, the failure is communicated better via notifications so that the user may retry. Finally, this makes the `deleting` property of the job visible (also it was renamed from `deleted`). This allows a client to render a deleting job differently. Closes #32836
91 lines
2.4 KiB
Plaintext
91 lines
2.4 KiB
Plaintext
[role="xpack"]
|
|
[testenv="platinum"]
|
|
[[ml-delete-job]]
|
|
=== Delete Jobs API
|
|
++++
|
|
<titleabbrev>Delete Jobs</titleabbrev>
|
|
++++
|
|
|
|
Deletes an existing anomaly detection job.
|
|
|
|
|
|
==== Request
|
|
|
|
`DELETE _xpack/ml/anomaly_detectors/<job_id>`
|
|
|
|
|
|
==== Description
|
|
|
|
All job configuration, model state and results are deleted.
|
|
|
|
IMPORTANT: Deleting a job must be done via this API only. Do not delete the
|
|
job directly from the `.ml-*` indices using the Elasticsearch
|
|
DELETE Document API. When {security} is enabled, make sure no `write`
|
|
privileges are granted to anyone over the `.ml-*` indices.
|
|
|
|
Before you can delete a job, you must delete the {dfeeds} that are associated
|
|
with it. See <<ml-delete-datafeed,Delete {dfeeds-cap}>>. Unless the `force` parameter
|
|
is used the job must be closed before it can be deleted.
|
|
|
|
It is not currently possible to delete multiple jobs using wildcards or a comma
|
|
separated list.
|
|
|
|
==== Path Parameters
|
|
|
|
`job_id` (required)::
|
|
(string) Identifier for the job
|
|
|
|
===== Query Parameters
|
|
|
|
`force`::
|
|
(boolean) Use to forcefully delete an opened job; this method is quicker than
|
|
closing and deleting the job.
|
|
|
|
`wait_for_completion`::
|
|
(boolean) Specifies whether the request should return immediately or wait
|
|
until the job deletion completes. Defaults to `true`.
|
|
|
|
==== Authorization
|
|
|
|
You must have `manage_ml`, or `manage` cluster privileges to use this API.
|
|
For more information, see {xpack-ref}/security-privileges.html[Security Privileges].
|
|
|
|
|
|
==== Examples
|
|
|
|
The following example deletes the `total-requests` job:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
DELETE _xpack/ml/anomaly_detectors/total-requests
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[skip:setup:server_metrics_job]
|
|
|
|
When the job is deleted, you receive the following results:
|
|
[source,js]
|
|
----
|
|
{
|
|
"acknowledged": true
|
|
}
|
|
----
|
|
// TESTRESPONSE
|
|
|
|
In the next example we delete the `total-requests` job asynchronously:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
DELETE _xpack/ml/anomaly_detectors/total-requests?wait_for_completion=false
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[skip:setup:server_metrics_job]
|
|
|
|
When `wait_for_completion` is set to `false`, the response contains the id
|
|
of the job deletion task:
|
|
[source,js]
|
|
----
|
|
{
|
|
"task": "oTUltX4IQMOUUVeiohTt8A:39"
|
|
}
|
|
----
|
|
// TESTRESPONSE[s/"task": "oTUltX4IQMOUUVeiohTt8A:39"/"task": $body.task/] |