mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-27 08:37:18 -04:00
89 lines
2.2 KiB
Text
89 lines
2.2 KiB
Text
[role="xpack"]
|
|
[[ml-stop-datafeed]]
|
|
= Stop {dfeeds} API
|
|
|
|
[subs="attributes"]
|
|
++++
|
|
<titleabbrev>Stop {dfeeds}</titleabbrev>
|
|
++++
|
|
|
|
Stops one or more {dfeeds}.
|
|
|
|
[[ml-stop-datafeed-request]]
|
|
== {api-request-title}
|
|
|
|
`POST _ml/datafeeds/<feed_id>/_stop` +
|
|
|
|
`POST _ml/datafeeds/<feed_id>,<feed_id>/_stop` +
|
|
|
|
`POST _ml/datafeeds/_all/_stop`
|
|
|
|
[[ml-stop-datafeed-prereqs]]
|
|
== {api-prereq-title}
|
|
|
|
Requires the `manage_ml` cluster privilege. This privilege is included in the
|
|
`machine_learning_admin` built-in role.
|
|
|
|
[[ml-stop-datafeed-desc]]
|
|
== {api-description-title}
|
|
|
|
A {dfeed} that is stopped ceases to retrieve data from {es}.
|
|
A {dfeed} can be started and stopped multiple times throughout its lifecycle.
|
|
|
|
[[ml-stop-datafeed-path-parms]]
|
|
== {api-path-parms-title}
|
|
|
|
`<feed_id>`::
|
|
(Required, string)
|
|
Identifier for the datafeed. You can stop multiple {dfeeds} in a single API
|
|
request by using a comma-separated list of {dfeeds} or a wildcard expression.
|
|
You can close all {dfeeds} by using `_all` or by specifying `*` as the
|
|
identifier.
|
|
|
|
[[ml-stop-datafeed-query-parms]]
|
|
== {api-query-parms-title}
|
|
|
|
`allow_no_match`::
|
|
(Optional, Boolean)
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-datafeeds]
|
|
|
|
`force`::
|
|
(Optional, Boolean) If true, the {dfeed} is stopped forcefully.
|
|
|
|
`timeout`::
|
|
(Optional, time) Specifies the amount of time to wait until a {dfeed} stops.
|
|
The default value is 20 seconds.
|
|
|
|
[[ml-stop-datafeed-request-body]]
|
|
== {api-request-body-title}
|
|
|
|
You can also specify the query parameters (such as `allow_no_match` and
|
|
`force`) in the request body.
|
|
|
|
[[ml-stop-datafeed-response-codes]]
|
|
== {api-response-codes-title}
|
|
|
|
`404` (Missing resources)::
|
|
If `allow_no_match` is `false`, this code indicates that there are no
|
|
resources that match the request or only partial matches for the request.
|
|
|
|
[[ml-stop-datafeed-example]]
|
|
== {api-examples-title}
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
POST _ml/datafeeds/datafeed-low_request_rate/_stop
|
|
{
|
|
"timeout": "30s"
|
|
}
|
|
--------------------------------------------------
|
|
// TEST[skip:Kibana sample data]
|
|
|
|
When the {dfeed} stops, you receive the following results:
|
|
|
|
[source,console-result]
|
|
----
|
|
{
|
|
"stopped": true
|
|
}
|
|
----
|