2019-07-05 07:34:05 -04:00
|
|
|
[role="xpack"]
|
|
|
|
|
[testenv="platinum"]
|
|
|
|
|
[[stop-dfanalytics]]
|
2020-07-20 16:06:29 -04:00
|
|
|
= Stop {dfanalytics-jobs} API
|
2019-07-05 07:34:05 -04:00
|
|
|
|
|
|
|
|
[subs="attributes"]
|
|
|
|
|
++++
|
|
|
|
|
<titleabbrev>Stop {dfanalytics-jobs}</titleabbrev>
|
|
|
|
|
++++
|
|
|
|
|
|
|
|
|
|
Stops one or more {dfanalytics-jobs}.
|
|
|
|
|
|
2019-07-12 11:26:31 -04:00
|
|
|
experimental[]
|
|
|
|
|
|
2019-07-05 07:34:05 -04:00
|
|
|
[[ml-stop-dfanalytics-request]]
|
2020-07-20 16:06:29 -04:00
|
|
|
== {api-request-title}
|
2019-07-05 07:34:05 -04:00
|
|
|
|
|
|
|
|
`POST _ml/data_frame/analytics/<data_frame_analytics_id>/_stop` +
|
|
|
|
|
|
|
|
|
|
`POST _ml/data_frame/analytics/<data_frame_analytics_id>,<data_frame_analytics_id>/_stop` +
|
|
|
|
|
|
|
|
|
|
`POST _ml/data_frame/analytics/_all/_stop`
|
|
|
|
|
|
|
|
|
|
[[ml-stop-dfanalytics-prereq]]
|
2020-07-20 16:06:29 -04:00
|
|
|
== {api-prereq-title}
|
2019-07-05 07:34:05 -04:00
|
|
|
|
2020-01-09 04:44:07 -05:00
|
|
|
If the {es} {security-features} are enabled, you must have the following built-in roles or equivalent privileges:
|
|
|
|
|
|
|
|
|
|
* `machine_learning_admin`
|
|
|
|
|
|
2020-07-23 19:43:10 -04:00
|
|
|
For more information, see <<built-in-roles>> and {ml-docs-setup-privileges}.
|
2020-01-09 04:44:07 -05:00
|
|
|
|
2019-07-05 07:34:05 -04:00
|
|
|
|
|
|
|
|
[[ml-stop-dfanalytics-desc]]
|
2020-07-20 16:06:29 -04:00
|
|
|
== {api-description-title}
|
2019-07-05 07:34:05 -04:00
|
|
|
|
|
|
|
|
A {dfanalytics-job} can be started and stopped multiple times throughout its
|
|
|
|
|
lifecycle.
|
|
|
|
|
|
|
|
|
|
You can stop multiple {dfanalytics-jobs} in a single API request by using a
|
|
|
|
|
comma-separated list of {dfanalytics-jobs} or a wildcard expression. You can
|
|
|
|
|
stop all {dfanalytics-job} by using _all or by specifying * as the
|
|
|
|
|
<data_frame_analytics_id>.
|
|
|
|
|
|
|
|
|
|
[[ml-stop-dfanalytics-path-params]]
|
2020-07-20 16:06:29 -04:00
|
|
|
== {api-path-parms-title}
|
2019-07-05 07:34:05 -04:00
|
|
|
|
2019-07-12 11:26:31 -04:00
|
|
|
`<data_frame_analytics_id>`::
|
2019-12-13 05:48:21 -05:00
|
|
|
(Required, string)
|
2020-06-01 16:46:15 -04:00
|
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-define]
|
2019-07-12 11:26:31 -04:00
|
|
|
|
|
|
|
|
[[ml-stop-dfanalytics-query-params]]
|
2020-07-20 16:06:29 -04:00
|
|
|
== {api-query-parms-title}
|
2019-07-05 07:34:05 -04:00
|
|
|
|
2019-07-12 11:26:31 -04:00
|
|
|
`allow_no_match`::
|
2019-12-13 05:48:21 -05:00
|
|
|
(Optional, boolean)
|
2020-06-01 16:46:15 -04:00
|
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match]
|
2019-12-13 05:48:21 -05:00
|
|
|
|
2019-07-10 20:58:17 -04:00
|
|
|
|
2019-07-12 11:26:31 -04:00
|
|
|
`force`::
|
|
|
|
|
(Optional, boolean) If true, the {dfanalytics-job} is stopped forcefully.
|
2019-07-05 07:34:05 -04:00
|
|
|
|
2019-07-12 11:26:31 -04:00
|
|
|
`timeout`::
|
2019-12-13 05:48:21 -05:00
|
|
|
(Optional, <<time-units,time units>>)
|
2020-06-01 16:46:15 -04:00
|
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=timeout-stop]
|
2019-07-12 11:26:31 -04:00
|
|
|
|
2019-07-05 07:34:05 -04:00
|
|
|
|
|
|
|
|
[[ml-stop-dfanalytics-example]]
|
2020-07-20 16:06:29 -04:00
|
|
|
== {api-examples-title}
|
2019-07-05 07:34:05 -04:00
|
|
|
|
|
|
|
|
The following example stops the `loganalytics` {dfanalytics-job}:
|
|
|
|
|
|
2019-09-09 12:35:50 -04:00
|
|
|
[source,console]
|
2019-07-05 07:34:05 -04:00
|
|
|
--------------------------------------------------
|
|
|
|
|
POST _ml/data_frame/analytics/loganalytics/_stop
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
// TEST[skip:TBD]
|
|
|
|
|
|
|
|
|
|
When the {dfanalytics-job} stops, you receive the following results:
|
|
|
|
|
|
2019-09-06 09:22:08 -04:00
|
|
|
[source,console-result]
|
2019-07-05 07:34:05 -04:00
|
|
|
----
|
|
|
|
|
{
|
|
|
|
|
"stopped" : true
|
|
|
|
|
}
|
|
|
|
|
----
|
