原文地址: https://www.elastic.co/guide/en/elasticsearch/reference/7.7/ml-get-calendar.html, 原文档版权归 www.elastic.co 所有
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
Elasticsearch Guide [7.7] » REST APIs » Machine learning anomaly detection APIs » Get calendars API
« Get buckets API Get categories API »

Get calendars APIedit

Retrieves configuration information for calendars.

Requestedit

GET _ml/calendars/<calendar_id>

GET _ml/calendars/_all

Prerequisitesedit

  • If the Elasticsearch security features are enabled, you must have monitor_ml, monitor, manage_ml, or manage 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) 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"
      ]
    }
  ]
}
« Get buckets API Get categories API »