启动数据帧分析作业 API编辑

启动数据帧分析作业。

请求编辑

POST _ml/data_frame/analytics/<data_frame_analytics_id>/_start

先决条件编辑

需要以下权限

  • 集群:manage_mlmachine_learning_admin 内置角色授予此权限)
  • 源索引:readview_index_metadata
  • 目标索引:readcreate_indexmanageindex

描述编辑

数据帧分析作业在其生命周期中可以多次启动和停止。

如果目标索引不存在,则会在您首次启动数据帧分析作业时自动创建该索引。目标索引的 index.number_of_shardsindex.number_of_replicas 设置将从源索引复制。如果有多个源索引,则目标索引将复制最高的设置值。目标索引的映射也会从源索引复制。如果存在任何映射冲突,则作业将无法启动。

如果目标索引存在,则按原样使用。因此,您可以使用自定义设置和映射预先设置目标索引。

启用 Elasticsearch 安全功能后,数据帧分析作业会记住创建它的用户,并使用这些凭据运行作业。如果您在创建作业时提供了辅助授权标头,则将使用这些凭据。

路径参数编辑

<data_frame_analytics_id>
(必填,字符串)数据帧分析作业的标识符。此标识符可以包含小写字母数字字符(a-z 和 0-9)、连字符和下划线。它必须以字母数字字符开头和结尾。

查询参数编辑

timeout
(可选,时间单位)控制等待数据帧分析作业启动的时间量。默认为 20 秒。

响应正文编辑

acknowledged
(布尔值)对于成功的响应,此值始终为 true。失败时,将返回异常。
node
(字符串)启动作业的节点的 ID。如果允许作业延迟打开且尚未分配给节点,则此值为一个空字符串。

示例编辑

以下示例启动了 loganalytics 数据帧分析作业

POST _ml/data_frame/analytics/loganalytics/_start

数据帧分析作业启动后,您将收到以下结果

{
  "acknowledged" : true,
  "node" : "node-1"
}