root
/
elasticsearch
mirror of https://github.com/elastic/elasticsearch.git
1
0
Fork 0
Code Issues Actions 1 Packages Projects Releases Wiki Activity
elasticsearch/docs/reference/ml/anomaly-detection/apis
History
Dimitris Athanasiou dc61a72c9e
[ML] Reset anomaly detection job API (#73908) 
Adds a new API that allows a user to reset
an anomaly detection job.

To use the API do:

```
POST _ml/anomaly_detectors/<job_id>_reset
```

The API removes all data associated to the job.
In particular, it deletes model state, results and stats.

However, job notifications and user annotations are not removed.

Also, the API can be called asynchronously by setting the parameter
`wait_for_completion` to `false` (defaults to `true`). When run
that way the API returns the task id for further monitoring.

In order to prevent the job from opening while it is resetting,
a new job field has been added called `blocked`. It is an object
that contains a `reason` and the `task_id`. `reason` can take
a value from ["delete", "reset", "revert"] as all these
operations should block the job from opening. The `task_id` is also
included in order to allow tracking the task if necessary.

Finally, this commit also sets the `blocked` field when
the revert snapshot API is called as a job should not be opened
while it is reverted to a different model snapshot.
 		2021-06-14 18:56:28 +03:00
..
close-job.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
delete-calendar-event.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
delete-calendar-job.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
delete-calendar.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
delete-datafeed.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
delete-expired-data.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
delete-filter.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
delete-forecast.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
delete-job.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
delete-snapshot.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
estimate-model-memory.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
flush-job.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
forecast.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
get-bucket.asciidoc [DOCS] Adds defaults to get ML results APIs (#73540) 2021-06-03 10:05:47 -07:00
get-calendar-event.asciidoc [DOCS] Adds defaults to get ML results APIs (#73540) 2021-06-03 10:05:47 -07:00
get-calendar.asciidoc [DOCS] Adds defaults to get ML results APIs (#73540) 2021-06-03 10:05:47 -07:00
get-category.asciidoc [DOCS] Adds defaults to get ML results APIs (#73540) 2021-06-03 10:05:47 -07:00
get-datafeed-stats.asciidoc [ML] adding running_state to datafeed stats object (#73926) 2021-06-10 08:08:49 -04:00
get-datafeed.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
get-filter.asciidoc [DOCS] Adds defaults to get ML results APIs (#73540) 2021-06-03 10:05:47 -07:00
get-influencer.asciidoc [DOCS] Adds defaults to get ML results APIs (#73540) 2021-06-03 10:05:47 -07:00
get-job-stats.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
get-job.asciidoc [ML] Reset anomaly detection job API (#73908) 2021-06-14 18:56:28 +03:00
get-ml-info.asciidoc [ML] Make ml_standard tokenizer the default for new categorization jobs (#72805) 2021-06-01 15:11:32 +01:00
get-overall-buckets.asciidoc [DOCS] Adds defaults to get ML results APIs (#73540) 2021-06-03 10:05:47 -07:00
get-record.asciidoc [DOCS] Adds defaults to get ML results APIs (#73540) 2021-06-03 10:05:47 -07:00
get-snapshot.asciidoc [DOCS] Adds defaults to get ML results APIs (#73540) 2021-06-03 10:05:47 -07:00
index.asciidoc [ML] Reset anomaly detection job API (#73908) 2021-06-14 18:56:28 +03:00
ml-apis.asciidoc [ML] Reset anomaly detection job API (#73908) 2021-06-14 18:56:28 +03:00
open-job.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
post-calendar-event.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
post-data.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
preview-datafeed.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
put-calendar-job.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
put-calendar.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
put-datafeed.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
put-filter.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
put-job.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
reset-job.asciidoc [ML] Reset anomaly detection job API (#73908) 2021-06-14 18:56:28 +03:00
revert-snapshot.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
set-upgrade-mode.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
start-datafeed.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
stop-datafeed.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
update-datafeed.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
update-filter.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
update-job.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
update-snapshot.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
upgrade-job-model-snapshot.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
validate-detector.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00
validate-job.asciidoc [DOCS] Revises required privileges info in Anomaly Detection API docs (#72483) 2021-05-03 10:20:14 +02:00