IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Stops one or more datafeeds.
A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle.
POST _ml/datafeeds/<feed_id>/_stop
POST _ml/datafeeds/<feed_id>,<feed_id>/_stop
POST _ml/datafeeds/_all/_stop
-
feed_id
- (string) Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression.
-
allow_no_datafeeds
-
(Optional, boolean) Specifies what to do when the request:
- Contains wildcard expressions and there are no {datafeeds} that match.
-
Contains the
_all
string or no identifiers and there are no matches. - Contains wildcard expressions and there are only partial matches.
The default value is
true
, which returns an emptydatafeeds
array when there are no matches and the subset of results when there are partial matches. If this parameter isfalse
, the request returns a404
status code when there are no matches or only partial matches.
-
force
- (boolean) If true, the datafeed is stopped forcefully.
-
timeout
- (time) Controls the amount of time to wait until a datafeed stops. The default value is 20 seconds.
-
404
(Missing resources) -
If
allow_no_datafeeds
isfalse
, this code indicates that there are no resources that match the request or only partial matches for the request.
You must have manage_ml
, or manage
cluster privileges to use this API.
For more information, see
Security privileges.