删除异常检测作业 API

编辑

删除现有的异常检测作业。

请求

编辑

DELETE _ml/anomaly_detectors/<job_id>

先决条件

编辑
  • 需要 manage_ml 集群权限。此权限包含在 machine_learning_admin 内置角色中。
  • 在删除作业之前,您必须关闭它(除非您指定 force 参数)。请参阅关闭作业

描述

编辑

所有作业配置、模型状态和结果都将被删除。

删除异常检测作业必须仅通过此 API 完成。请勿使用 Elasticsearch 删除文档 API 直接从 .ml-* 索引中删除作业。当启用 Elasticsearch 安全功能时,请确保没有授予任何人对 .ml-* 索引的 write 权限。

目前无法使用通配符或逗号分隔列表删除多个作业。

如果删除具有数据馈送的作业,则请求将首先尝试删除数据馈送。此行为等效于使用与删除作业请求相同的 timeoutforce 参数调用 删除数据馈送

路径参数

编辑
<job_id>
(必需,字符串)异常检测作业的标识符。

查询参数

编辑
force
(可选,布尔值)用于强制删除已打开的作业;此方法比关闭并删除作业更快。
wait_for_completion
(可选,布尔值)指定请求应立即返回还是等待作业删除完成。默认为 true
delete_user_annotations
(可选,布尔值)指定在重置作业时,是否应删除用户添加的注释以及任何自动生成的注释。默认为 false

示例

编辑
resp = client.ml.delete_job(
    job_id="total-requests",
)
print(resp)
response = client.ml.delete_job(
  job_id: 'total-requests'
)
puts response
const response = await client.ml.deleteJob({
  job_id: "total-requests",
});
console.log(response);
DELETE _ml/anomaly_detectors/total-requests

当作业被删除时,您将收到以下结果

{
  "acknowledged": true
}

在下一个示例中,我们异步删除 total-requests 作业

resp = client.ml.delete_job(
    job_id="total-requests",
    wait_for_completion=False,
)
print(resp)
response = client.ml.delete_job(
  job_id: 'total-requests',
  wait_for_completion: false
)
puts response
const response = await client.ml.deleteJob({
  job_id: "total-requests",
  wait_for_completion: "false",
});
console.log(response);
DELETE _ml/anomaly_detectors/total-requests?wait_for_completion=false

wait_for_completion 设置为 false 时,响应包含作业删除任务的 id

{
  "task": "oTUltX4IQMOUUVeiohTt8A:39"
}