異常検出ジョブのリセットAPI

既存の異常検出ジョブをリセットします。

リクエスト

POST _ml/anomaly_detectors/<job_id>/_reset

前提条件

  • manage_ml クラスター権限が必要です。この権限は machine_learning_admin ビルトインロールに含まれています。
  • ジョブをリセットする前に、ジョブを閉じる必要があります。ジョブを閉じる際に force を true に設定することで、ジョブの完了を待たずに済みます。詳細は ジョブを閉じる を参照してください。

説明

すべてのモデルの状態と結果が削除されます。ジョブは新たに作成されたかのように再スタートする準備が整います。

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

パスパラメータ

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

クエリパラメータ

  • wait_for_completion
  • (オプション、Boolean) リクエストが即座に返されるべきか、ジョブのリセットが完了するまで待つべきかを指定します。デフォルトは true です。
  • delete_user_annotations
  • (オプション、Boolean) ジョブがリセットされる際に、ユーザーによって追加された注釈が自動生成された注釈と共に削除されるべきかを指定します。デフォルトは false です。

例

Python

  1. resp = client.ml.reset_job(
  2.    job_id="total-requests",
  3. )
  4. print(resp)

Ruby

  1. response = client.ml.reset_job(
  2.   job_id: 'total-requests'
  3. )
  4. puts response

Js

  1. const response = await client.ml.resetJob({
  2.   job_id: "total-requests",
  3. });
  4. console.log(response);

コンソール

  1. POST _ml/anomaly_detectors/total-requests/_reset

ジョブがリセットされると、次の結果が得られます：

コンソール-結果

  1. {
  2.   "acknowledged": true
  3. }

次の例では、total-requests ジョブを非同期にリセットします：

Python

  1. resp = client.ml.reset_job(
  2.    job_id="total-requests",
  3.    wait_for_completion=False,
  4. )
  5. print(resp)

Ruby

  1. response = client.ml.reset_job(
  2.   job_id: 'total-requests',
  3.   wait_for_completion: false
  4. )
  5. puts response

Js

  1. const response = await client.ml.resetJob({
  2.   job_id: "total-requests",
  3.   wait_for_completion: "false",
  4. });
  5. console.log(response);

コンソール

  1. POST _ml/anomaly_detectors/total-requests/_reset?wait_for_completion=false

wait_for_completion が false に設定されている場合、レスポンスにはジョブリセットタスクのIDが含まれます：

コンソール-結果

  1. {
  2.   "task": "oTUltX4IQMOUUVeiohTt8A:39"
  3. }

リセットタスクのステータスを確認したい場合は、タスクIDを参照して タスク管理 を使用してください。