删除异常检测作业 API
编辑删除异常检测作业 API编辑
删除现有的异常检测作业。
请求编辑
DELETE _ml/anomaly_detectors/<job_id>
先决条件编辑
- 需要
manage_ml
集群权限。此权限包含在machine_learning_admin
内置角色中。 - 在删除作业之前,您必须关闭它(除非您指定
force
参数)。请参阅 关闭作业。
描述编辑
所有作业配置、模型状态和结果都将被删除。
删除异常检测作业必须仅通过此 API 完成。不要使用 Elasticsearch 删除文档 API 直接从 .ml-*
索引中删除作业。当 Elasticsearch 安全功能启用时,请确保没有向任何人授予对 .ml-*
索引的 write
权限。
目前无法使用通配符或逗号分隔列表删除多个作业。
如果您删除具有数据馈送的作业,请求首先尝试删除数据馈送。此行为等效于调用 删除数据馈送,并使用与删除作业请求相同的 timeout
和 force
参数。
路径参数编辑
-
<job_id>
- (必需,字符串) 异常检测作业的标识符。
查询参数编辑
-
force
- (可选,布尔值) 用于强制删除打开的作业;此方法比关闭和删除作业更快。
-
wait_for_completion
- (可选,布尔值) 指定请求应立即返回还是等待作业删除完成。默认为
true
。 -
delete_user_annotations
- (可选,布尔值) 指定在重置作业时,用户添加的注释是否应与任何自动生成的注释一起删除。默认为
false
。
示例编辑
response = client.ml.delete_job( job_id: 'total-requests' ) puts response
DELETE _ml/anomaly_detectors/total-requests
删除作业时,您将收到以下结果
{ "acknowledged": true }
在下一个示例中,我们将异步删除 total-requests
作业
response = client.ml.delete_job( job_id: 'total-requests', wait_for_completion: false ) puts response
DELETE _ml/anomaly_detectors/total-requests?wait_for_completion=false
当 wait_for_completion
设置为 false
时,响应将包含作业删除任务的 ID
{ "task": "oTUltX4IQMOUUVeiohTt8A:39" }