获取日历 API

编辑

检索日历的配置信息。

请求

编辑

GET _ml/calendars/<calendar_id>

GET _ml/calendars/_all

先决条件

编辑

需要 monitor_ml 集群权限。此权限包含在 machine_learning_user 内置角色中。

描述

编辑

有关更多信息,请参阅 日历和计划事件

路径参数

编辑
<calendar_id>

(必需,字符串)唯一标识日历的字符串。

您可以通过使用逗号分隔的 ID 列表或通配符表达式,在单个 API 请求中获取多个日历的信息。您可以通过使用 _all,指定 * 作为日历标识符,或者省略标识符来获取所有日历的信息。

查询参数

编辑
from
(可选,整数)跳过指定数量的日历。仅当您省略 <calendar_id> 时才支持此参数。默认为 0
size
(可选,整数)指定要获取的最大日历数量。仅当您省略 <calendar_id> 时才支持此参数。默认为 100

请求体

编辑
page
page 的属性
from
(可选,整数)跳过指定数量的日历。仅当您省略 <calendar_id> 时才支持此对象。默认为 0
size
(可选,整数)指定要获取的最大日历数量。仅当您省略 <calendar_id> 时才支持此对象。默认为 100

响应体

编辑

API 返回一个日历资源数组,这些资源具有以下属性

calendar_id
(字符串)唯一标识日历的字符串。
job_ids
(数组)异常检测作业标识符的数组。例如:["total-requests"]

示例

编辑
resp = 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

API 返回以下结果

{
  "count": 1,
  "calendars": [
    {
      "calendar_id": "planned-outages",
      "job_ids": [
        "total-requests"
      ]
    }
  ]
}