84 lines
1.5 KiB
Plaintext
84 lines
1.5 KiB
Plaintext
[role="xpack"]
|
|
[testenv="platinum"]
|
|
[[ml-get-calendar]]
|
|
=== Get calendars API
|
|
++++
|
|
<titleabbrev>Get calendars</titleabbrev>
|
|
++++
|
|
|
|
Retrieves configuration information for calendars.
|
|
|
|
|
|
==== Request
|
|
|
|
`GET _ml/calendars/<calendar_id>` +
|
|
|
|
`GET _ml/calendars/_all`
|
|
|
|
|
|
===== Description
|
|
|
|
You can get information for a single calendar or for all calendars by using
|
|
`_all`.
|
|
|
|
|
|
==== Path Parameters
|
|
|
|
`calendar_id`::
|
|
(string) Identifier for the calendar.
|
|
|
|
|
|
==== Request Body
|
|
|
|
`from`:::
|
|
(integer) Skips the specified number of calendars.
|
|
|
|
`size`:::
|
|
(integer) Specifies the maximum number of calendars to obtain.
|
|
|
|
|
|
==== Results
|
|
|
|
The API returns the following information:
|
|
|
|
`calendars`::
|
|
(array) An array of calendar resources.
|
|
For more information, see <<ml-calendar-resource>>.
|
|
|
|
|
|
==== Authorization
|
|
|
|
You must have `monitor_ml`, `monitor`, `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 gets configuration information for the `planned-outages`
|
|
calendar:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET _ml/calendars/planned-outages
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[skip:setup:calendar_outages_addjob]
|
|
|
|
The API returns the following results:
|
|
[source,js]
|
|
----
|
|
{
|
|
"count": 1,
|
|
"calendars": [
|
|
{
|
|
"calendar_id": "planned-outages",
|
|
"job_ids": [
|
|
"total-requests"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
----
|
|
// TESTRESPONSE
|