mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 15:47:23 -04:00
69 lines
1.5 KiB
Text
69 lines
1.5 KiB
Text
[role="xpack"]
|
|
[[delete-dfanalytics]]
|
|
= Delete {dfanalytics-jobs} API
|
|
[subs="attributes"]
|
|
++++
|
|
<titleabbrev>Delete {dfanalytics-jobs}</titleabbrev>
|
|
++++
|
|
|
|
.New API reference
|
|
[sidebar]
|
|
--
|
|
For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-data-frame[{ml-cap} {dfanalytics} APIs].
|
|
--
|
|
|
|
Deletes an existing {dfanalytics-job}.
|
|
|
|
|
|
[[ml-delete-dfanalytics-request]]
|
|
== {api-request-title}
|
|
|
|
`DELETE _ml/data_frame/analytics/<data_frame_analytics_id>`
|
|
|
|
|
|
[[ml-delete-dfanalytics-prereq]]
|
|
== {api-prereq-title}
|
|
|
|
Requires the `manage_ml` cluster privilege. This privilege is included in the
|
|
`machine_learning_admin` built-in role.
|
|
|
|
|
|
[[ml-delete-dfanalytics-path-params]]
|
|
== {api-path-parms-title}
|
|
|
|
`<data_frame_analytics_id>`::
|
|
(Required, string)
|
|
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics]
|
|
|
|
[[ml-delete-dfanalytics-query-params]]
|
|
== {api-query-parms-title}
|
|
|
|
`force`::
|
|
(Optional, Boolean) If `true`, it deletes a job that is not stopped; this method is
|
|
quicker than stopping and deleting the job.
|
|
|
|
`timeout`::
|
|
(Optional, <<time-units,time units>>) The time to wait for the job to be deleted.
|
|
Defaults to 1 minute.
|
|
|
|
|
|
|
|
[[ml-delete-dfanalytics-example]]
|
|
== {api-examples-title}
|
|
|
|
The following example deletes the `loganalytics` {dfanalytics-job}:
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
DELETE _ml/data_frame/analytics/loganalytics
|
|
--------------------------------------------------
|
|
// TEST[skip:TBD]
|
|
|
|
The API returns the following result:
|
|
|
|
[source,console-result]
|
|
----
|
|
{
|
|
"acknowledged" : true
|
|
}
|
|
----
|