原英文版地址: https://www.elastic.co/guide/en/elasticsearch/reference/7.7/ml-get-calendar.html, 原文档版权归 www.elastic.co 所有
本地英文版地址: ../en/ml-get-calendar.html
本地英文版地址: ../en/ml-get-calendar.html
重要: 此版本不会发布额外的bug修复或文档更新。最新信息请参考 当前版本文档。
Get calendars APIedit
Retrieves configuration information for calendars.
Prerequisitesedit
-
If the Elasticsearch security features are enabled, you must have
monitor_ml,monitor,manage_ml, ormanagecluster 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) A string that uniquely identifies a calendar.
Request bodyedit
-
page.from - (Optional, integer) Skips the specified number of calendars.
-
page.size - (Optional, integer) Specifies the maximum number of calendars to obtain.
Response bodyedit
The 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"].
Examplesedit
GET _ml/calendars/planned-outages
The API returns the following results:
{
"count": 1,
"calendars": [
{
"calendar_id": "planned-outages",
"job_ids": [
"total-requests"
]
}
]
}