mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-30 10:23:41 -04:00
7242267f5d
This PR adds the reference documentation pages of the data frame analytics APIs (PUT, START, STOP, GET, GET stats, DELETE, Evaluate) to the ML APIs pool.
52 lines
No EOL
1.2 KiB
Text
52 lines
No EOL
1.2 KiB
Text
[role="xpack"]
|
|
[testenv="platinum"]
|
|
[[delete-dfanalytics]]
|
|
=== Delete {dfanalytics-jobs} API
|
|
[subs="attributes"]
|
|
++++
|
|
<titleabbrev>Delete {dfanalytics-jobs}</titleabbrev>
|
|
++++
|
|
|
|
experimental[]
|
|
|
|
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}
|
|
|
|
* You must have `machine_learning_admin` built-in role to use this API. For more
|
|
information, see {stack-ov}/security-privileges.html[Security privileges] and
|
|
{stack-ov}/built-in-roles.html[Built-in roles].
|
|
|
|
[[ml-delete-dfanalytics-path-params]]
|
|
==== {api-path-parms-title}
|
|
|
|
`<data_frame_analytics_id>` (Required)::
|
|
(string) Identifier for the {dfanalytics-job} you want to delete.
|
|
|
|
[[ml-delete-dfanalytics-example]]
|
|
==== {api-examples-title}
|
|
|
|
The following example deletes the `loganalytics` {dfanalytics-job}:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
DELETE _ml/data_frame/analytics/loganalytics
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[skip:TBD]
|
|
|
|
The API returns the following result:
|
|
|
|
[source,js]
|
|
----
|
|
{
|
|
"acknowledged" : true
|
|
}
|
|
----
|
|
// TESTRESPONSE |