启动数据框分析作业 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 数据框分析作业

resp = client.ml.start_data_frame_analytics(
    id="loganalytics",
)
print(resp)
const response = await client.ml.startDataFrameAnalytics({
  id: "loganalytics",
});
console.log(response);
POST _ml/data_frame/analytics/loganalytics/_start

当数据框分析作业启动时,您会收到以下结果

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