mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-30 10:23:41 -04:00
f56a0f4b66
Removes `testenv` annotations and related code. These annotations originally let you skip x-pack snippet tests in the docs. However, that's no longer possible. Relates to #79309, #31619
51 lines
1.1 KiB
Text
51 lines
1.1 KiB
Text
[role="xpack"]
|
|
[[ml-put-calendar-job]]
|
|
= Add {anomaly-jobs} to calendar API
|
|
++++
|
|
<titleabbrev>Add jobs to calendar</titleabbrev>
|
|
++++
|
|
|
|
Adds an {anomaly-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}
|
|
|
|
Requires the `manage_ml` cluster privilege. This privilege is included in the
|
|
`machine_learning_admin` built-in role.
|
|
|
|
[[ml-put-calendar-job-path-parms]]
|
|
== {api-path-parms-title}
|
|
|
|
`<calendar_id>`::
|
|
(Required, string)
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=calendar-id]
|
|
|
|
`<job_id>`::
|
|
(Required, string)
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-list]
|
|
|
|
[[ml-put-calendar-job-example]]
|
|
== {api-examples-title}
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
PUT _ml/calendars/planned-outages/jobs/total-requests
|
|
--------------------------------------------------
|
|
// TEST[skip:setup:calendar_outages_openjob]
|
|
|
|
The API returns the following results:
|
|
|
|
[source,console-result]
|
|
----
|
|
{
|
|
"calendar_id": "planned-outages",
|
|
"job_ids": [
|
|
"total-requests"
|
|
]
|
|
}
|
|
----
|