61 lines
1.6 KiB
Plaintext
61 lines
1.6 KiB
Plaintext
|
[[ml-delete-snapshot]]
|
||
|
|
==== Delete Model Snapshots
|
||
|
|
|
||
|
|
The delete model snapshot API allows you to delete an existing model snapshot.
|
||
|
|
|
||
|
|
===== Request
|
||
|
|
|
||
|
|
`DELETE _xpack/ml/anomaly_detectors/<job_id>/model_snapshots/<snapshot_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 data feeds that are associated with it.
|
||
|
|
//See <<>>.
|
||
|
|
|
||
|
|
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
|
||
|
|
|
||
|
|
`snapshot_id` (required)::
|
||
|
|
(+string+) Identifier for the model snapshot
|
||
|
|
////
|
||
|
|
===== Responses
|
||
|
|
|
||
|
|
200
|
||
|
|
(EmptyResponse) The cluster has been successfully deleted
|
||
|
|
404
|
||
|
|
(BasicFailedReply) The cluster specified by {cluster_id} cannot be found (code: clusters.cluster_not_found)
|
||
|
|
412
|
||
|
|
(BasicFailedReply) The Elasticsearch cluster has not been shutdown yet (code: clusters.cluster_plan_state_error)
|
||
|
|
|
||
|
|
|
||
|
|
===== Examples
|
||
|
|
|
||
|
|
The following example deletes the `event_rate` job:
|
||
|
|
|
||
|
|
[source,js]
|
||
|
|
--------------------------------------------------
|
||
|
|
DELETE _xpack/ml/anomaly_detectors/event_rate
|
||
|
|
--------------------------------------------------
|
||
|
|
// CONSOLE
|
||
|
|
// TEST[skip:todo]
|
||
|
|
|
||
|
|
When the job is deleted, you receive the following results:
|
||
|
|
----
|
||
|
|
{
|
||
|
|
"acknowledged": true
|
||
|
|
}
|
||
|
|
----
|
||
|
|
////
|