55 lines
1.2 KiB
Plaintext
55 lines
1.2 KiB
Plaintext
[role="xpack"]
|
|
[testenv="platinum"]
|
|
[[ml-delete-calendar-job]]
|
|
=== Delete Jobs from Calendar API
|
|
++++
|
|
<titleabbrev>Delete Jobs from Calendar</titleabbrev>
|
|
++++
|
|
|
|
Deletes jobs from a calendar.
|
|
|
|
|
|
==== Request
|
|
|
|
`DELETE _xpack/ml/calendars/<calendar_id>/jobs/<job_id>`
|
|
|
|
|
|
==== Path Parameters
|
|
|
|
`calendar_id`(required)::
|
|
(string) Identifier for the calendar.
|
|
|
|
`job_id` (required)::
|
|
(string) An identifier for the job. It can be a job identifier, a group name, or a
|
|
comma-separated list of jobs or groups.
|
|
|
|
|
|
==== Authorization
|
|
|
|
You must have `manage_ml`, or `manage` cluster privileges to use this API.
|
|
For more information, see {xpack-ref}/security-privileges.html[Security Privileges].
|
|
|
|
==== Examples
|
|
|
|
The following example removes the association between the `planned-outages`
|
|
calendar and `total-requests` job:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
DELETE _xpack/ml/calendars/planned-outages/jobs/total-requests
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[skip:setup:calendar_outages_addjob]
|
|
|
|
When the job is removed from the calendar, you receive the following
|
|
results:
|
|
|
|
[source,js]
|
|
----
|
|
{
|
|
"calendar_id": "planned-outages",
|
|
"job_ids": []
|
|
}
|
|
----
|
|
// TESTRESPONSE
|