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-get-calendar]]
|
2018-12-20 13:23:28 -05:00
|
|
|
=== Get calendars API
|
2017-12-20 19:37:19 -05:00
|
|
|
++++
|
2018-12-20 13:23:28 -05:00
|
|
|
<titleabbrev>Get calendars</titleabbrev>
|
2017-12-20 19:37:19 -05:00
|
|
|
++++
|
2017-12-20 16:52:58 -05:00
|
|
|
|
2018-06-13 16:37:35 -04:00
|
|
|
Retrieves configuration information for calendars.
|
2017-12-20 16:52:58 -05:00
|
|
|
|
2019-06-27 12:42:47 -04:00
|
|
|
[[ml-get-calendar-request]]
|
|
|
|
==== {api-request-title}
|
2017-12-20 16:52:58 -05:00
|
|
|
|
2018-12-07 15:34:11 -05:00
|
|
|
`GET _ml/calendars/<calendar_id>` +
|
2017-12-20 16:52:58 -05:00
|
|
|
|
2018-12-07 15:34:11 -05:00
|
|
|
`GET _ml/calendars/_all`
|
2017-12-20 16:52:58 -05:00
|
|
|
|
2019-06-27 16:58:42 -04:00
|
|
|
[[ml-get-calendar-prereqs]]
|
|
|
|
==== {api-prereq-title}
|
|
|
|
|
|
|
|
* If the {es} {security-features} are enabled, you must have `monitor_ml`,
|
|
|
|
`monitor`, `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-get-calendar-desc]]
|
|
|
|
==== {api-description-title}
|
2018-01-24 11:14:23 -05:00
|
|
|
|
|
|
|
You can get information for a single calendar or for all calendars by using
|
|
|
|
`_all`.
|
2017-12-20 16:52:58 -05:00
|
|
|
|
2019-07-15 12:44:57 -04:00
|
|
|
For more information, see
|
2019-12-20 13:01:19 -05:00
|
|
|
{ml-docs}/ml-calendars.html[Calendars and scheduled events].
|
2019-07-15 12:44:57 -04:00
|
|
|
|
2019-06-27 12:42:47 -04:00
|
|
|
[[ml-get-calendar-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)
|
|
|
|
include::{docdir}/ml/ml-shared.asciidoc[tag=calendar-id]
|
2017-12-20 16:52:58 -05:00
|
|
|
|
2019-06-27 12:42:47 -04:00
|
|
|
[[ml-get-calendar-request-body]]
|
|
|
|
==== {api-request-body-title}
|
2017-12-20 16:52:58 -05:00
|
|
|
|
2020-01-02 14:23:26 -05:00
|
|
|
`page`.`from`::
|
|
|
|
(Optional, integer) Skips the specified number of calendars.
|
2017-12-20 16:52:58 -05:00
|
|
|
|
2020-01-02 14:23:26 -05:00
|
|
|
`page`.`size`::
|
|
|
|
(Optional, integer) Specifies the maximum number of calendars to obtain.
|
2017-12-20 16:52:58 -05:00
|
|
|
|
2019-06-27 12:42:47 -04:00
|
|
|
[[ml-get-calendar-results]]
|
|
|
|
==== {api-response-body-title}
|
2018-01-24 11:14:23 -05:00
|
|
|
|
2020-01-02 14:23:26 -05:00
|
|
|
The API returns an array of calendar resources, which have the following
|
|
|
|
properties:
|
2017-12-20 16:52:58 -05:00
|
|
|
|
2020-01-02 14:23:26 -05:00
|
|
|
`calendar_id`::
|
|
|
|
(string)
|
|
|
|
include::{docdir}/ml/ml-shared.asciidoc[tag=calendar-id]
|
2019-07-15 12:44:57 -04:00
|
|
|
|
2020-01-02 14:23:26 -05:00
|
|
|
`job_ids`::
|
|
|
|
(array) An array of {anomaly-job} identifiers. For example: `["total-requests"]`.
|
2018-01-24 11:14:23 -05:00
|
|
|
|
2019-06-27 12:42:47 -04:00
|
|
|
[[ml-get-calendar-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
|
|
|
GET _ml/calendars/planned-outages
|
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
|
|
|
|
|
|
|
The API returns the following results:
|
2019-09-06 09:22:08 -04:00
|
|
|
|
|
|
|
[source,console-result]
|
2018-01-24 11:14:23 -05:00
|
|
|
----
|
|
|
|
{
|
|
|
|
"count": 1,
|
|
|
|
"calendars": [
|
|
|
|
{
|
|
|
|
"calendar_id": "planned-outages",
|
|
|
|
"job_ids": [
|
|
|
|
"total-requests"
|
|
|
|
]
|
|
|
|
}
|
|
|
|
]
|
|
|
|
}
|
|
|
|
----
|