異常検出ジョブモデルスナップショットアップグレード統計API

異常検出ジョブモデルスナップショットアップグレードの使用情報を取得します。

リクエスト

GET _ml/anomaly_detectors/<job_id>/model_snapshots/<snapshot_id>/_upgrade/_stats

GET _ml/anomaly_detectors/<job_id>,<job_id>/model_snapshots/_all/_upgrade/_stats

GET _ml/anomaly_detectors/_all/model_snapshots/_all/_upgrade/_stats

前提条件

monitor_ml クラスター権限が必要です。この権限は machine_learning_user ビルトインロールに含まれています。

説明

異常検出ジョブモデルスナップショットのアップグレードは一時的です。このAPIが呼び出された時点で進行中のアップグレードのみが返されます。

パスパラメータ

  • <job_id>
  • (文字列) 異常検出ジョブの識別子。ジョブ識別子、グループ名、またはワイルドカード式であることができます。
  • <snapshot_id>
  • (文字列) モデルスナップショットの識別子。
    カンマ区切りのスナップショットIDリストを使用することで、単一のAPIリクエストで複数の異常検出ジョブモデルスナップショットのアップグレードの統計を取得できます。ワイルドカード式や _all を使用することもできます。

クエリパラメータ

  • allow_no_match
  • (オプション、ブール値) リクエスト時の動作を指定します:
    • ワイルドカード式を含み、一致するジョブがない場合。
    • _all 文字列を含むか、識別子がない場合で、一致がない場合。
    • ワイルドカード式を含み、一部の一致のみがある場合。
      デフォルト値は true で、一致がない場合は空の jobs 配列を返し、一部の一致がある場合は結果のサブセットを返します。このパラメータが false の場合、一致がないか一部の一致のみがある場合、リクエストは 404 ステータスコードを返します。

レスポンスボディ

APIは異常検出ジョブモデルスナップショットアップグレードステータスオブジェクトの配列を返します。これらのプロパティはすべて情報提供用であり、その値を更新することはできません。

  • assignment_explanation
  • (文字列) 開始されたデータフィードのみについて、ノードの選択に関するメッセージを含みます。
  • job_id
  • (文字列) 異常検出ジョブの識別子。
  • node
  • (オブジェクト) アップグレードタスクを実行するノードのプロパティを含みます。この情報は、ノードに割り当てられたアップグレードタスクにのみ利用可能です。
    詳細
    • attributes
    • (オブジェクト) ml.machine_memoryml.max_open_jobs 設定などのノード属性をリストします。
    • ephemeral_id
    • (文字列) ノードの一時ID。
    • id
    • (文字列) ノードの一意の識別子。
    • name
    • (文字列) ノード名。例えば、0-o0tOo
    • transport_address
    • (文字列) トランスポートHTTP接続が受け入れられるホストとポート。
  • snapshot_id
  • (文字列) モデルスナップショットを一意に識別する数値文字列。例えば、1575402236000
  • state
  • (文字列) loading_old_statesaving_new_statestopped または failed のいずれか。

レスポンスコード

  • 404 (リソースが見つかりません)
  • allow_no_matchfalse の場合、このコードはリクエストに一致するリソースがないか、リクエストに対して部分一致のみがあることを示します。

Python

  1. resp = client.ml.get_model_snapshot_upgrade_stats(
  2. job_id="low_request_rate",
  3. snapshot_id="_all",
  4. )
  5. print(resp)

Ruby

  1. response = client.ml.get_model_snapshot_upgrade_stats(
  2. job_id: 'low_request_rate',
  3. snapshot_id: '_all'
  4. )
  5. puts response

Js

  1. const response = await client.ml.getModelSnapshotUpgradeStats({
  2. job_id: "low_request_rate",
  3. snapshot_id: "_all",
  4. });
  5. console.log(response);

コンソール

  1. GET _ml/anomaly_detectors/low_request_rate/model_snapshots/_all/_upgrade/_stats

APIは次の結果を返します:

コンソール-結果

  1. {
  2. "count" : 1,
  3. "model_snapshot_upgrades" : [
  4. {
  5. "job_id" : "low_request_rate",
  6. "snapshot_id" : "1828371",
  7. "state" : "saving_new_state",
  8. "node" : {
  9. "id" : "7bmMXyWCRs-TuPfGJJ_yMw",
  10. "name" : "node-0",
  11. "ephemeral_id" : "hoXMLZB0RWKfR9UPPUCxXX",
  12. "transport_address" : "127.0.0.1:9300",
  13. "attributes" : {
  14. "ml.machine_memory" : "17179869184",
  15. "ml.max_open_jobs" : "512"
  16. }
  17. },
  18. "assignment_explanation" : ""
  19. }
  20. ]
  21. }