elasticsearch/docs/reference/ml/anomaly-detection
Dimitris Athanasiou 92f7c6250a
[7.x][ML] Reset anomaly detection job API (#73908) (#74093)
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.

Backport of #73908
2021-06-15 10:05:40 +03:00
..
apis [7.x][ML] Reset anomaly detection job API (#73908) (#74093) 2021-06-15 10:05:40 +03:00
functions [DOCS] Swap [float] for [discrete] (#60134) 2020-07-23 12:42:33 -04:00
ml-configuring-aggregations.asciidoc [DOCS] Removes Kibana charts-related advise about agg interval and bucket span. (#73673) (#73677) 2021-06-02 17:16:43 +02:00
ml-configuring-alerts.asciidoc [Docs] Update cross-document links to Kibana Alerting docs (#74034) (#74091) 2021-06-14 12:50:31 -04:00
ml-configuring-categories.asciidoc [ML] Make ml_standard tokenizer the default for new categorization jobs (#73605) 2021-06-02 07:04:16 +01:00
ml-configuring-detector-custom-rules.asciidoc [DOCS] Clarifies that custom rules are job rules in Kibana (#71678) (#71722) 2021-04-15 09:52:16 +02:00
ml-configuring-populations.asciidoc [DOCS] Changes level offset of anomaly detection pages (#59911) (#59940) 2020-07-20 17:04:59 -07:00
ml-configuring-transform.asciidoc [DOCS] Updates datafeed related runtime field examples (#73725) (#73886) 2021-06-08 11:39:36 +02:00
ml-configuring-url.asciidoc [DOCS] Makes the screenshot larger on the custom URLs page. (#65269) (#65297) 2020-11-20 15:25:15 +01:00
ml-delayed-data-detection.asciidoc [DOCS] Clarify impact of delayed data in anomaly detection (#66816) (#67039) 2021-01-05 13:09:30 -08:00