55 lines
1.1 KiB
Plaintext
55 lines
1.1 KiB
Plaintext
//lcawley Verified example output 2017-04-11
|
|
[[ml-stop-datafeed]]
|
|
=== Stop {dfeeds-cap}
|
|
|
|
A {dfeed} that is stopped ceases to retrieve data from {es}.
|
|
A {dfeed} can be started and stopped multiple times throughout its lifecycle.
|
|
|
|
==== Request
|
|
|
|
`POST _xpack/ml/datafeeds/<feed_id>/_stop`
|
|
|
|
//===== Description
|
|
|
|
==== Path Parameters
|
|
|
|
`feed_id` (required)::
|
|
(string) Identifier for the {dfeed}
|
|
|
|
==== Request Body
|
|
|
|
`force`::
|
|
(boolean) If true, the {dfeed} is stopped forcefully.
|
|
|
|
`timeout`::
|
|
(time) Controls the amount of time to wait until a {dfeed} stops.
|
|
The default value is 20 seconds.
|
|
|
|
|
|
==== Authorization
|
|
|
|
You must have `manage_ml`, or `manage` cluster privileges to use this API.
|
|
For more information, see <<privileges-list-cluster>>.
|
|
|
|
==== Examples
|
|
|
|
The following example stops the `datafeed-it-ops-kpi` {dfeed}:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
POST _xpack/ml/datafeeds/datafeed-it-ops-kpi/_stop
|
|
{
|
|
"timeout": "30s"
|
|
}
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[skip:todo]
|
|
|
|
When the {dfeed} stops, you receive the following results:
|
|
[source,js]
|
|
----
|
|
{
|
|
"stopped": true
|
|
}
|
|
----
|