WARNING: Version 6.2 of Elasticsearch has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
This API enables you to retrieve information about the scheduled events in calendars.
GET _xpack/ml/calendars/<calendar_id>/events
GET _xpack/ml/calendars/_all/events
-
end - (string) Specifies to get events with timestamps earlier than this time.
-
from - (integer) Skips the specified number of events.
-
size - (integer) Specifies the maximum number of events to obtain.
-
start - (string) Specifies to get events with timestamps after this time.
The API returns the following information:
-
events - (array) An array of scheduled event resources. For more information, see Scheduled Event Resources.
You must have monitor_ml, monitor, manage_ml, or manage cluster
privileges to use this API. For more information, see
Security Privileges.
The following example gets information about the scheduled events in the
planned-outages calendar:
GET _xpack/ml/calendars/planned-outages/events
The API returns the following results:
{
"count": 3,
"events": [
{
"description": "event 1",
"start_time": 1513641600000,
"end_time": 1513728000000,
"calendar_id": "planned-outages",
"event_id": "LS8LJGEBMTCMA-qz49st"
},
{
"description": "event 2",
"start_time": 1513814400000,
"end_time": 1513900800000,
"calendar_id": "planned-outages",
"event_id": "Li8LJGEBMTCMA-qz49st"
},
{
"description": "event 3",
"start_time": 1514160000000,
"end_time": 1514246400000,
"calendar_id": "planned-outages",
"event_id": "Ly8LJGEBMTCMA-qz49st"
}
]
}
For more information about these properties, see Scheduled Event Resources.