ジョブを削除（Delete jobs）

異常検知ジョブ削除API

既存の異常検知ジョブを削除します。

リクエスト

DELETE _ml/anomaly_detectors/<job_id>

前提条件

• manage_ml クラスター権限が必要です。この権限は machine_learning_admin ビルトインロールに含まれています。
• ジョブを削除する前に、ジョブを閉じる必要があります（force パラメータを指定しない限り）。ジョブを閉じるを参照してください。

説明

すべてのジョブ設定、モデルの状態、および結果が削除されます。

異常検知ジョブの削除は、このAPIを介してのみ行う必要があります。Elasticsearchの削除ドキュメントAPIを使用して、.ml-* インデックスから直接ジョブを削除しないでください。Elasticsearchのセキュリティ機能が有効になっている場合、write 権限が .ml-* インデックスに対して誰にも付与されていないことを確認してください。

ワイルドカードやカンマ区切りのリストを使用して複数のジョブを削除することは現在できません。

データフィードを持つジョブを削除すると、リクエストは最初にデータフィードを削除しようとします。この動作は、削除ジョブリクエストと同じ timeout および force パラメータを使用して データフィードを削除 を呼び出すことに相当します。

パスパラメータ

• <job_id>
• (必須、文字列) 異常検知ジョブの識別子。

クエリパラメータ

• force
• (オプション、ブール値) 開いているジョブを強制的に削除するために使用します。この方法は、ジョブを閉じて削除するよりも迅速です。
• wait_for_completion
• (オプション、ブール値) リクエストが即座に返されるべきか、ジョブ削除が完了するまで待機するべきかを指定します。デフォルトは true です。
• delete_user_annotations
• (オプション、ブール値) ジョブがリセットされるときに、ユーザーによって追加された注釈が自動生成された注釈とともに削除されるべきかどうかを指定します。デフォルトは false です。

例

Python

resp = client.ml.delete_job(
   job_id="total-requests",
)
print(resp)

Ruby

response = client.ml.delete_job(
  job_id: 'total-requests'
)
puts response

Js

const response = await client.ml.deleteJob({
  job_id: "total-requests",
});
console.log(response);

コンソール

DELETE _ml/anomaly_detectors/total-requests

ジョブが削除されると、次の結果が返されます:

コンソール-結果

{
  "acknowledged": true
}

次の例では、total-requests ジョブを非同期に削除します:

Python

resp = client.ml.delete_job(
   job_id="total-requests",
   wait_for_completion=False,
)
print(resp)

Ruby

response = client.ml.delete_job(
  job_id: 'total-requests',
  wait_for_completion: false
)
puts response

Js

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"
}