This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
Get calendars API
editGet calendars API
editRetrieves configuration information for calendars.
Prerequisites
editRequires the monitor_ml
cluster privilege. This privilege is included in the
machine_learning_user
built-in role.
Description
editFor more information, see Calendars and scheduled events.
Path parameters
edit-
<calendar_id>
-
(Required, string) A string that uniquely identifies a calendar.
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.
Query parameters
edit-
from
-
(Optional, integer) Skips the specified number of calendars. This parameter
is supported only when you omit the
<calendar_id>
. Defaults to0
. -
size
-
(Optional, integer) Specifies the maximum number of calendars to obtain.
This parameter is supported only when you omit the
<calendar_id>
. Defaults to100
.
Request body
edit-
page
-
Properties of
page
-
from
-
(Optional, integer) Skips the specified number of calendars. This object is
supported only when you omit the
<calendar_id>
. Defaults to0
. -
size
-
(Optional, integer) Specifies the maximum number of calendars to obtain. This
object is supported only when you omit the
<calendar_id>
. Defaults to100
.
-
Response body
editThe API returns an array of calendar resources, which have the following properties:
-
calendar_id
- (string) A string that uniquely identifies a calendar.
-
job_ids
-
(array) An array of anomaly detection job identifiers. For example:
["total-requests"]
.
Examples
editresp = client.ml.get_calendars( calendar_id="planned-outages", ) print(resp)
response = client.ml.get_calendars( calendar_id: 'planned-outages' ) puts response
const response = await client.ml.getCalendars({ calendar_id: "planned-outages", }); console.log(response);
GET _ml/calendars/planned-outages
The API returns the following results:
{ "count": 1, "calendars": [ { "calendar_id": "planned-outages", "job_ids": [ "total-requests" ] } ] }