2017-06-20 09:23:58 +08:00
|
|
|
[role="xpack"]
|
2018-09-01 07:49:24 +08:00
|
|
|
[testenv="platinum"]
|
2017-04-05 06:26:39 +08:00
|
|
|
[[ml-delete-datafeed]]
|
2018-12-21 02:23:28 +08:00
|
|
|
=== Delete {dfeeds} API
|
2019-05-01 01:46:13 +08:00
|
|
|
|
|
|
|
[subs="attributes"]
|
2017-12-15 02:52:49 +08:00
|
|
|
++++
|
2018-12-21 02:23:28 +08:00
|
|
|
<titleabbrev>Delete {dfeeds}</titleabbrev>
|
2017-12-15 02:52:49 +08:00
|
|
|
++++
|
2017-04-05 06:26:39 +08:00
|
|
|
|
2018-06-14 04:37:35 +08:00
|
|
|
Deletes an existing {dfeed}.
|
2017-04-05 06:26:39 +08:00
|
|
|
|
2019-06-28 00:42:47 +08:00
|
|
|
[[ml-delete-datafeed-request]]
|
|
|
|
==== {api-request-title}
|
2017-04-05 06:26:39 +08:00
|
|
|
|
2018-12-08 04:34:11 +08:00
|
|
|
`DELETE _ml/datafeeds/<feed_id>`
|
2017-04-05 06:26:39 +08:00
|
|
|
|
2019-06-28 04:58:42 +08:00
|
|
|
[[ml-delete-datafeed-prereqs]]
|
|
|
|
==== {api-prereq-title}
|
|
|
|
|
2019-07-12 23:26:31 +08:00
|
|
|
* Unless you use the `force` parameter, you must stop the {dfeed} before you
|
|
|
|
can delete it.
|
2019-06-28 04:58:42 +08:00
|
|
|
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
|
|
|
`manage` cluster privileges to use this API. See
|
2019-10-05 07:10:26 +08:00
|
|
|
<<security-privileges>>.
|
2019-06-28 04:58:42 +08:00
|
|
|
|
2019-06-28 00:42:47 +08:00
|
|
|
[[ml-delete-datafeed-path-parms]]
|
|
|
|
==== {api-path-parms-title}
|
2017-04-05 06:26:39 +08:00
|
|
|
|
2019-07-12 23:26:31 +08:00
|
|
|
`<feed_id>`::
|
|
|
|
(Required, string) Identifier for the {dfeed}.
|
2017-04-05 06:26:39 +08:00
|
|
|
|
2019-06-28 00:42:47 +08:00
|
|
|
[[ml-delete-datafeed-query-parms]]
|
|
|
|
==== {api-query-parms-title}
|
2017-06-06 20:39:36 +08:00
|
|
|
|
2019-07-12 23:26:31 +08:00
|
|
|
`force`::
|
|
|
|
(Optional, boolean) Use to forcefully delete a started {dfeed}; this method is
|
|
|
|
quicker than stopping and deleting the {dfeed}.
|
2017-04-26 05:08:29 +08:00
|
|
|
|
2019-06-28 00:42:47 +08:00
|
|
|
[[ml-delete-datafeed-example]]
|
|
|
|
==== {api-examples-title}
|
2017-04-05 06:26:39 +08:00
|
|
|
|
2018-02-10 01:16:24 +08:00
|
|
|
The following example deletes the `datafeed-total-requests` {dfeed}:
|
2017-04-05 06:26:39 +08:00
|
|
|
|
2019-09-06 22:55:16 +08:00
|
|
|
[source,console]
|
2017-04-05 06:26:39 +08:00
|
|
|
--------------------------------------------------
|
2018-12-08 04:34:11 +08:00
|
|
|
DELETE _ml/datafeeds/datafeed-total-requests
|
2017-04-05 06:26:39 +08:00
|
|
|
--------------------------------------------------
|
2018-09-01 07:49:24 +08:00
|
|
|
// TEST[skip:setup:server_metrics_datafeed]
|
2017-04-05 06:26:39 +08:00
|
|
|
|
2017-05-03 03:45:42 +08:00
|
|
|
When the {dfeed} is deleted, you receive the following results:
|
2019-09-06 04:47:18 +08:00
|
|
|
|
|
|
|
[source,console-result]
|
2017-04-05 06:26:39 +08:00
|
|
|
----
|
|
|
|
{
|
|
|
|
"acknowledged": true
|
|
|
|
}
|
|
|
|
----
|