mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-29 01:44:36 -04:00
33a71e3289
* Remove `es-test-dir` book-scoped variable * Remove `plugins-examples-dir` book-scoped variable * Remove `:dependencies-dir:` and `:xes-repo-dir:` book-scoped variables - In `index.asciidoc`, two variables (`:dependencies-dir:` and `:xes-repo-dir:`) were removed. - In `sql/index.asciidoc`, the `:sql-tests:` path was updated to fuller path - In `esql/index.asciidoc`, the `:esql-tests:` path was updated idem * Replace `es-repo-dir` with `es-ref-dir` * Move `:include-xpack: true` to few files that use it, remove from index.asciidoc
109 lines
2.6 KiB
Text
109 lines
2.6 KiB
Text
[role="xpack"]
|
|
[[ml-get-calendar]]
|
|
= Get calendars API
|
|
++++
|
|
<titleabbrev>Get calendars</titleabbrev>
|
|
++++
|
|
|
|
Retrieves configuration information for calendars.
|
|
|
|
[[ml-get-calendar-request]]
|
|
== {api-request-title}
|
|
|
|
`GET _ml/calendars/<calendar_id>` +
|
|
|
|
`GET _ml/calendars/_all`
|
|
|
|
[[ml-get-calendar-prereqs]]
|
|
== {api-prereq-title}
|
|
|
|
Requires the `monitor_ml` cluster privilege. This privilege is included in the
|
|
`machine_learning_user` built-in role.
|
|
|
|
[[ml-get-calendar-desc]]
|
|
== {api-description-title}
|
|
|
|
For more information, see
|
|
{ml-docs}/ml-ad-run-jobs.html#ml-ad-calendars[Calendars and scheduled events].
|
|
|
|
[[ml-get-calendar-path-parms]]
|
|
== {api-path-parms-title}
|
|
|
|
`<calendar_id>`::
|
|
(Required, string)
|
|
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=calendar-id]
|
|
+
|
|
You can get information for multiple calendars in a single API request by using
|
|
a comma-separated list of ids or a wildcard expression. You can get information
|
|
for all calendars by using `_all`, by specifying `*` as the calendar identifier,
|
|
or by omitting the identifier.
|
|
|
|
[[ml-get-calendar-query-parms]]
|
|
== {api-query-parms-title}
|
|
|
|
`from`::
|
|
(Optional, integer) Skips the specified number of calendars. This parameter
|
|
is supported only when you omit the `<calendar_id>`. Defaults to `0`.
|
|
|
|
`size`::
|
|
(Optional, integer) Specifies the maximum number of calendars to obtain.
|
|
This parameter is supported only when you omit the `<calendar_id>`. Defaults
|
|
to `100`.
|
|
|
|
[[ml-get-calendar-request-body]]
|
|
== {api-request-body-title}
|
|
|
|
`page`::
|
|
+
|
|
.Properties of `page`
|
|
[%collapsible%open]
|
|
====
|
|
|
|
`from`:::
|
|
(Optional, integer) Skips the specified number of calendars. This object is
|
|
supported only when you omit the `<calendar_id>`. Defaults to `0`.
|
|
|
|
`size`:::
|
|
(Optional, integer) Specifies the maximum number of calendars to obtain. This
|
|
object is supported only when you omit the `<calendar_id>`. Defaults to `100`.
|
|
====
|
|
|
|
[[ml-get-calendar-results]]
|
|
== {api-response-body-title}
|
|
|
|
The API returns an array of calendar resources, which have the following
|
|
properties:
|
|
|
|
`calendar_id`::
|
|
(string)
|
|
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=calendar-id]
|
|
|
|
`job_ids`::
|
|
(array) An array of {anomaly-job} identifiers. For example:
|
|
`["total-requests"]`.
|
|
|
|
[[ml-get-calendar-example]]
|
|
== {api-examples-title}
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
GET _ml/calendars/planned-outages
|
|
--------------------------------------------------
|
|
// TEST[skip:setup:calendar_outages_addjob]
|
|
|
|
The API returns the following results:
|
|
|
|
[source,console-result]
|
|
----
|
|
{
|
|
"count": 1,
|
|
"calendars": [
|
|
{
|
|
"calendar_id": "planned-outages",
|
|
"job_ids": [
|
|
"total-requests"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
----
|