获取日历 API
编辑获取日历 API编辑
检索日历的配置信息。
先决条件编辑
需要 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"]。
示例编辑
response = client.ml.get_calendars( calendar_id: 'planned-outages' ) puts response
GET _ml/calendars/planned-outages
API 返回以下结果
{
"count": 1,
"calendars": [
{
"calendar_id": "planned-outages",
"job_ids": [
"total-requests"
]
}
]
}