IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Get calendars APIedit
Retrieves configuration information for calendars.
Prerequisitesedit
-
If the Elasticsearch security features are enabled, you must have
monitor_ml
,monitor
,manage_ml
, ormanage
cluster privileges to use this API. See Security privileges.
Descriptionedit
You can get information for a single calendar or for all calendars by using
_all
.
For more information, see Calendars and scheduled events.
Path parametersedit
-
<calendar_id>
- (Required, string) Identifier for the calendar.
Request bodyedit
-
page
-
-
from
- (Optional, integer) Skips the specified number of calendars.
-
size
- (Optional, integer) Specifies the maximum number of calendars to obtain.
-
Response bodyedit
The API returns the following information:
-
calendars
-
(array) An array of calendar resources. A calendar resource has the following properties:
-
calendar_id
- (string) A numerical character string that uniquely identifies the calendar.
-
job_ids
-
(array) An array of anomaly detection job identifiers. For example:
["total-requests"]
.
-
Examplesedit
The following example gets configuration information for the planned-outages
calendar:
GET _ml/calendars/planned-outages
The API returns the following results:
{ "count": 1, "calendars": [ { "calendar_id": "planned-outages", "job_ids": [ "total-requests" ] } ] }