2017-12-20 16:52:58 -05:00
|
|
|
[role="xpack"]
|
2018-08-31 19:49:24 -04:00
|
|
|
[testenv="platinum"]
|
2017-12-20 16:52:58 -05:00
|
|
|
[[ml-delete-calendar-job]]
|
2019-07-25 14:20:42 -04:00
|
|
|
=== Delete {anomaly-jobs} from calendar API
|
2017-12-20 16:52:58 -05:00
|
|
|
++++
|
2018-12-20 13:23:28 -05:00
|
|
|
<titleabbrev>Delete jobs from calendar</titleabbrev>
|
2017-12-20 16:52:58 -05:00
|
|
|
++++
|
|
|
|
|
2019-07-25 14:20:42 -04:00
|
|
|
Deletes {anomaly-jobs} from a calendar.
|
2017-12-20 16:52:58 -05:00
|
|
|
|
2019-06-27 12:42:47 -04:00
|
|
|
[[ml-delete-calendar-job-request]]
|
|
|
|
==== {api-request-title}
|
2017-12-20 16:52:58 -05:00
|
|
|
|
2018-12-07 15:34:11 -05:00
|
|
|
`DELETE _ml/calendars/<calendar_id>/jobs/<job_id>`
|
2017-12-20 16:52:58 -05:00
|
|
|
|
2019-06-27 16:58:42 -04:00
|
|
|
[[ml-delete-calendar-job-prereqs]]
|
|
|
|
==== {api-prereq-title}
|
|
|
|
|
|
|
|
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
|
|
|
`manage` cluster privileges to use this API. See
|
2019-10-07 18:23:19 -04:00
|
|
|
<<security-privileges>>.
|
2019-06-27 16:58:42 -04:00
|
|
|
|
2019-06-27 12:42:47 -04:00
|
|
|
[[ml-delete-calendar-job-path-parms]]
|
|
|
|
==== {api-path-parms-title}
|
2017-12-20 16:52:58 -05:00
|
|
|
|
2019-07-12 11:26:31 -04:00
|
|
|
`<calendar_id>`::
|
2020-01-02 14:23:26 -05:00
|
|
|
(Required, string)
|
2020-06-01 16:46:15 -04:00
|
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=calendar-id]
|
2017-12-20 16:52:58 -05:00
|
|
|
|
2019-07-12 11:26:31 -04:00
|
|
|
`<job_id>`::
|
2020-01-02 14:23:26 -05:00
|
|
|
(Required, string)
|
2020-06-01 16:46:15 -04:00
|
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-list]
|
2017-12-20 16:52:58 -05:00
|
|
|
|
2019-06-27 12:42:47 -04:00
|
|
|
[[ml-delete-calendar-job-example]]
|
|
|
|
==== {api-examples-title}
|
2018-01-24 11:14:23 -05:00
|
|
|
|
2019-09-06 11:31:13 -04:00
|
|
|
[source,console]
|
2018-01-24 11:14:23 -05:00
|
|
|
--------------------------------------------------
|
2018-12-07 15:34:11 -05:00
|
|
|
DELETE _ml/calendars/planned-outages/jobs/total-requests
|
2018-01-24 11:14:23 -05:00
|
|
|
--------------------------------------------------
|
2018-08-31 19:49:24 -04:00
|
|
|
// TEST[skip:setup:calendar_outages_addjob]
|
2018-01-24 11:14:23 -05:00
|
|
|
|
|
|
|
When the job is removed from the calendar, you receive the following
|
|
|
|
results:
|
|
|
|
|
2019-09-06 09:22:08 -04:00
|
|
|
[source,console-result]
|
2018-01-24 11:14:23 -05:00
|
|
|
----
|
|
|
|
{
|
|
|
|
"calendar_id": "planned-outages",
|
|
|
|
"job_ids": []
|
|
|
|
}
|
|
|
|
----
|