同步机器学习保存对象 API
编辑同步机器学习保存对象 API编辑
同步 Kibana 保存对象以用于机器学习作业和训练模型。
有关最新 API 详细信息,请参阅 开放 API 规范。
请求编辑
GET <kibana 主机>:<端口>/api/ml/saved_objects/sync
GET <kibana 主机>:<端口>/s/<空间 ID>/api/ml/saved_objects/sync
先决条件编辑
您必须对 Kibana 功能权限 中的 机器学习 功能具有 all
权限。
描述编辑
此 API 在您启动 Kibana 时以及之后定期自动运行。
路径参数编辑
-
space_id
- (可选,字符串) 空间的标识符。如果 URL 中未提供
space_id
,则使用默认空间。
查询参数编辑
-
simulate
- (可选,布尔值) 当
true
时,模拟同步,仅返回将要执行的操作列表。
响应正文编辑
-
datafeedsAdded
- (数组) 如果异常检测作业的保存对象缺少数据馈送标识符,则会添加它。此列表包含数据馈送标识符,并指示同步是否成功。
-
datafeedsRemoved
- (数组) 如果异常检测作业的保存对象引用了不再存在的数据馈送,则会将其删除。此列表包含数据馈送标识符,并指示同步是否成功。
-
savedObjectsCreated
- (数组) 如果机器学习作业或训练模型缺少保存对象,则会创建它们。此列表包含作业和模型标识符,并指示同步是否成功。
-
savedObjectsDeleted
- (数组) 如果机器学习作业或训练模型存在不再存在的保存对象,则会将其删除。此列表包含作业和模型标识符,并指示同步是否成功。
响应代码编辑
-
200
- 表示调用成功。
示例编辑
检索需要同步的机器学习保存对象列表
GET api/ml/saved_objects/sync?simulate=true
例如,如果需要同步两个作业,则 API 返回以下响应
{"savedObjectsCreated":{"anomaly_detector":{"myjob1":{"success":true},"myjob2":{"success":true}}},"savedObjectsDeleted":{},"datafeedsAdded":{},"datafeedsRemoved":{}}
要执行同步,请重新运行 API 并省略 simulate
参数。