更新数据帧分析作业 API
编辑更新数据帧分析作业 API编辑
更新现有的数据帧分析作业。
请求编辑
POST _ml/data_frame/analytics/<data_frame_analytics_id>/_update
先决条件编辑
需要以下权限
- 集群：
manage_ml（machine_learning_admin内置角色授予此权限） - 源索引：
read、view_index_metadata - 目标索引：
read、create_index、manage和index
数据帧分析作业会记住更新它时用户拥有的角色。当您启动作业时，它会使用相同的角色执行分析。如果您提供 辅助授权标头，则会使用这些凭据。
描述编辑
此 API 更新现有的数据帧分析作业，该作业对源索引执行分析并将结果存储在目标索引中。
路径参数编辑
-
<data_frame_analytics_id> - （必需，字符串）数据帧分析作业的标识符。此标识符可以包含小写字母数字字符（a-z 和 0-9）、连字符和下划线。它必须以字母数字字符开头和结尾。
请求正文编辑
-
allow_lazy_start - （可选，布尔值）指定此作业是否可以在机器学习节点容量不足以立即将其分配给节点时启动。默认值为
false；如果无法立即找到具有运行作业容量的机器学习节点，则 API 会返回错误。但是，这也受集群范围的xpack.ml.max_lazy_ml_nodes设置的约束。请参阅 高级机器学习设置。如果将此选项设置为true，则 API 不会返回错误，并且作业将在starting状态下等待，直到有足够的机器学习节点容量可用。 -
description - （可选，字符串）作业的描述。
-
max_num_threads - （可选，整数）分析要使用的最大线程数。默认值为
1。使用更多线程可能会减少完成分析所需的时间，但会使用更多 CPU。请注意，该过程可能会为除分析本身以外的操作功能使用其他线程。 -
_meta - （可选，对象）高级配置选项。包含有关作业的自定义元数据。例如，它可以包含自定义 URL 信息。
-
model_memory_limit - （可选，字符串）分析处理允许使用的最大内存资源量（近似值）。数据帧分析作业的默认值为
1gb。如果您为xpack.ml.max_model_memory_limit设置指定了值，则在尝试创建model_memory_limit值大于该设置值的作业时会发生错误。有关更多信息，请参阅 机器学习设置。
示例编辑
更新模型内存限制示例编辑
以下示例演示如何更新现有数据帧分析配置的模型内存限制。
POST _ml/data_frame/analytics/loganalytics/_update
{
"model_memory_limit": "200mb"
}
更新作业后，响应将包含其配置，其中包含更新的值。例如
{
"id" : "loganalytics",
"create_time" : 1656364565517,
"version" : "8.4.0",
"authorization" : {
"roles" : [
"superuser"
]
},
"description" : "Outlier detection on log data",
"source" : {
"index" : [
"logdata"
],
"query" : {
"match_all" : { }
}
},
"dest" : {
"index" : "logdata_out",
"results_field" : "ml"
},
"analysis" : {
"outlier_detection" : {
"compute_feature_influence" : true,
"outlier_fraction" : 0.05,
"standardization_enabled" : true
}
},
"model_memory_limit" : "200mb",
"allow_lazy_start" : false,
"max_num_threads" : 1
}