58 lines
1.3 KiB
Plaintext
58 lines
1.3 KiB
Plaintext
[role="xpack"]
|
|
[testenv="platinum"]
|
|
[[ml-put-calendar-job]]
|
|
=== Add jobs to calendar API
|
|
++++
|
|
<titleabbrev>Add jobs to calendar</titleabbrev>
|
|
++++
|
|
|
|
Adds a job to a calendar.
|
|
|
|
[[ml-put-calendar-job-request]]
|
|
==== {api-request-title}
|
|
|
|
`PUT _ml/calendars/<calendar_id>/jobs/<job_id>`
|
|
|
|
[[ml-put-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
|
|
{stack-ov}/security-privileges.html[Security privileges].
|
|
|
|
[[ml-put-calendar-job-path-parms]]
|
|
==== {api-path-parms-title}
|
|
|
|
`<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.
|
|
|
|
[[ml-put-calendar-job-example]]
|
|
==== {api-examples-title}
|
|
|
|
The following example associates the `planned-outages` calendar with the
|
|
`total-requests` job:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
PUT _ml/calendars/planned-outages/jobs/total-requests
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[skip:setup:calendar_outages_openjob]
|
|
|
|
The API returns the following results:
|
|
|
|
[source,js]
|
|
----
|
|
{
|
|
"calendar_id": "planned-outages",
|
|
"job_ids": [
|
|
"total-requests"
|
|
]
|
|
}
|
|
----
|
|
// TESTRESPONSE
|