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
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
..
aggregations Add keep_values gap policy (#73297) 2021-06-08 09:47:29 -10:00
analysis [DOCS] Fix formatting 2021-05-04 12:29:14 -04:00
autoscaling [DOCS] Use partially mounted in autoscaling docs (#73229) 2021-05-20 11:18:42 +02:00
cat [DOCS] Update `<alias>` parameter for cat aliases API (#73526) 2021-05-28 10:03:46 -04:00
ccr Add support for index pattern exclusion in CCR AutoFollow (#72935) 2021-06-04 13:53:30 +02:00
cluster [DOCS] Update alias references (#73427) 2021-05-27 16:00:57 -04:00
commands Service Accounts - add beta version documentation (#71729) 2021-05-13 07:55:42 -04:00
data-management [DOCS] How to migrate to node roles from node attrs. Closes #65855 (#71160) 2021-04-27 14:39:54 -07:00
data-streams [DOCS] Update alias references (#73427) 2021-05-27 16:00:57 -04:00
docs [DOCS] Fix `_tasks` API endpoint reference (#73379) (#73531) 2021-05-28 11:19:12 -04:00
eql [DOCS] Fix typo in modulo example 2021-06-03 08:21:29 -04:00
features/apis Make feature reset API response more informative (#71240) 2021-04-27 13:47:10 -04:00
fleet Wait on index when polling global checkpoints (#71890) 2021-04-20 13:04:42 -06:00
graph [DOCS] Fix API titles (#67475) 2021-01-13 15:15:37 -05:00
high-availability [DOCS] Replace 'log into' with 'log in to' (#72324) 2021-04-27 15:27:22 -04:00
how-to Remove unneeded word 2021-06-02 15:12:34 -04:00
ilm [DOCS] Fix ILM action order (#74021) 2021-06-10 14:28:44 -04:00
images SQL: Add ODBC proxy support documentation (#73263) 2021-05-20 16:56:02 +02:00
index-modules [doc] Fix typo in slowlog.asciidoc (#73803) 2021-06-07 09:50:50 +02:00
indices [DOCS] Clone index API doesn't copy index metadata (#73787) 2021-06-07 08:36:58 -04:00
ingest [DOCS] Create a new page for grok content in scripting docs (#73118) 2021-05-27 15:18:34 -04:00
licensing [DOCS] Note get license API can return a `404` (#73951) 2021-06-10 09:19:20 -04:00
mapping Update runtime.asciidoc (#73802) 2021-06-07 09:36:05 -04:00
migration Breaking change for single data node setting (#73737) 2021-06-07 13:12:04 +02:00
ml [ML] Reset anomaly detection job API (#73908) 2021-06-14 18:56:28 +03:00
modules Fix docs rendering around recovery rate table (#73879) 2021-06-08 15:00:00 +01:00
monitoring Recommend cluster scope for Metricbeat (#70865) 2021-05-10 14:16:46 +01:00
query-dsl Add doc on rank_feature(s) negative score impact (#71795) 2021-04-20 06:56:05 -04:00
release-notes [DOCS] Replace version-specific links in release highlights (#70317) (#70386) 2021-03-15 10:20:12 -04:00
repositories-metering-api [DOCS] Fix name of `cluster_version` parameter (#69615) 2021-03-01 08:54:47 -05:00
rest-api [DOCS] Reuse `aliases` object properties in API docs (#73421) 2021-06-02 08:31:42 -04:00
rollup [DOCS] Fix double spaces (#71082) 2021-03-31 09:57:47 -04:00
scripting [DOCS] Remove errant note (#73597) (#73600) 2021-06-01 09:41:09 -04:00
search [DOCS] Remove 'closed data stream' reference 2021-05-27 16:07:09 -04:00
searchable-snapshots [DOCS] Update alias references (#73427) 2021-05-27 16:00:57 -04:00
settings [DOCS] Fix client_authentication setting default (#73743) 2021-06-04 14:22:47 +10:00
setup [DOCS] Remove `PrintCompressedOopsMode` JVM option (#73741) 2021-06-09 09:43:33 -04:00
slm [DOCS] Clarify when SLM deletes expired snapshots (#73155) 2021-05-17 10:02:08 -04:00
snapshot-restore Note repo must not be registered during restore (#73740) 2021-06-07 10:14:13 +01:00
sql SQL: Add ODBC proxy support documentation (#73263) 2021-05-20 16:56:02 +02:00
tab-widgets [DOCS] Rename mount types for searchable snapshots (#72699) 2021-05-05 16:35:33 -04:00
text-structure/apis [ML] [DOCS] update find-structure reference docs (#67586) 2021-01-15 12:19:38 -05:00
transform [DOCS] Fixes typo in transforms at scale page. (#73726) 2021-06-03 18:27:36 +02:00
upgrade Extend version barrier to all upgrades (#73358) 2021-06-01 09:07:23 +01:00
vectors Add access to dense_vector values (#71313) 2021-04-19 08:02:05 -04:00
aggregations.asciidoc Convert bucket aggs docs to runtime fields (#71202) 2021-04-02 12:12:06 -04:00
alias.asciidoc [DOCS] Use `bool` query in alias filter example (#73619) 2021-06-01 12:05:40 -04:00
analysis.asciidoc [DOCS] Fix Lucene's stop words links (#70405) 2021-03-16 17:06:12 -04:00
api-conventions.asciidoc [DOCS] Update alias references (#73427) 2021-05-27 16:00:57 -04:00
cat.asciidoc [DOCS] Remove unneeded escapes 2021-04-26 12:14:45 -04:00
cluster.asciidoc [DOCS] Reword node roles docs (#69301) 2021-02-23 11:32:46 -05:00
data-management.asciidoc [DOCS] Move Kibana index mgmt docs to ES (#64380) 2020-10-30 09:14:52 -04:00
data-rollup-transform.asciidoc [DOCS] Add overview for rollup refactor (#70001) 2021-03-10 08:41:27 -05:00
datatiers.asciidoc [DOCS] recommend dedicated frozen tier (#72882) 2021-05-11 20:41:10 +02:00
dependencies-versions.asciidoc [DOCS] Added appendix to show dependencies (#67962) 2021-01-26 16:16:05 -08:00
docs.asciidoc [DOCS] Update single index APIs reference (#73103) 2021-05-14 11:53:34 -04:00
getting-started.asciidoc [DOCS] Shorten quick start response (#72622) 2021-05-03 11:17:47 -04:00
glossary.asciidoc [DOCS] Add alias guide (#73062) 2021-05-25 11:52:16 -04:00
gs-index.asciidoc
…
high-availability.asciidoc [DOCS] Add docs for designing resilient clusters (#47233) 2020-06-05 11:48:44 -04:00
how-to.asciidoc [DOCS] Add 'Fix common cluster issues' docs (#72097) 2021-04-28 08:28:51 -04:00
index-extra-title-page.html
…
index-modules.asciidoc [DOCS] Fix double spaces (#71082) 2021-03-31 09:57:47 -04:00
index.asciidoc Fix docs path for docs PR to pass 2021-06-01 16:55:13 +02:00
index.x.asciidoc
…
indices.asciidoc [DOCS] Add alias guide (#73062) 2021-05-25 11:52:16 -04:00
ingest.asciidoc Expose dynamic_templates parameter in Ingest (#71716) 2021-04-19 11:34:13 -04:00
intro.asciidoc [DOCS] Fix double spaces (#71082) 2021-03-31 09:57:47 -04:00
links.asciidoc [DOCS] Rename ES Reference to ES Guide (#71198) 2021-04-01 15:38:41 -04:00
mapping.asciidoc Minor revision missed in merge. (#67282) 2021-01-11 13:50:06 -05:00
query-dsl.asciidoc [DOC] Fix typos (#71869) (#71948) 2021-04-20 11:47:29 -04:00
redirects.asciidoc [DOCS] Create a new page for grok content in scripting docs (#73118) 2021-05-27 15:18:34 -04:00
release-notes.asciidoc
…
scripting.asciidoc [DOCS] Move common scripting use cases up a level (#73445) 2021-05-27 07:38:55 -04:00
search.asciidoc Links new TermsEnum api into docs. Remove superfluous “API” from page title. (#72992) 2021-05-12 16:21:36 +01:00
setup.asciidoc [DOCS] Edit JVM settings info. Closes #72259 (#72350) 2021-04-28 18:30:32 -07:00
upgrade.asciidoc [DOCS] Add tip for upgrade assistant (#55027) 2020-05-05 09:49:22 -04:00