Get anomaly detection job model snapshot upgrade usage info Generally available; Added in 7.16.0

GET /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade/_stats
Api key auth Basic auth Bearer auth

highlight#highlightFromAnchor" href="#topic-required-authorization"> Required authorization

  • Cluster privileges: monitor_ml

Path parameters

  • job_id string Required

    Identifier for the anomaly detection job.

  • snapshot_id string Required

    A numerical character string that uniquely identifies the model snapshot. You can get information for multiple snapshots by using a comma-separated list or a wildcard expression. You can get all snapshots by using _all, by specifying * as the snapshot ID, or by omitting the snapshot ID.

Query parameters

  • allow_no_match boolean

    Specifies what to do when the request:

    • Contains wildcard expressions and there are no jobs that match.
    • Contains the _all string or no identifiers and there are no matches.
    • Contains wildcard expressions and there are only partial matches.

    The default value is true, which returns an empty jobs array when there are no matches and the subset of results when there are partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches.

Responses

  • 200 application/json
    details#setActive"> Hide response attributes Show response attributes object
    • count number Required
    • model_snapshot_upgrades array[object] Required
      details#setActive"> Hide model_snapshot_upgrades attributes Show model_snapshot_upgrades attributes object
      • job_id string Required
      • snapshot_id string Required
      • state string Required

        Values are loading_old_state, saving_new_state, stopped, or failed.

      • node object Required
        details#setActive"> Hide node attribute Show node attribute object
        • * object Additional properties
          details#setActive"> Hide * attributes Show * attributes object
          • name string
          • ephemeral_id string Required
          • transport_address string Required
          • external_id string Required
          • attributes object Required
            details#setActive"> Hide attributes attribute Show attributes attribute object
            • * string Additional properties
          • roles array[string] Required
          • version string Required
          • min_index_version number Required
          • max_index_version number Required
      • assignment_explanation string Required
GET /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade/_stats
dropdown#toggle click@window->dropdown#hide touchend@window->dropdown#hide" data-dropdown-target="button" data-scrollable="false" data-headings="false" aria-expanded="false" aria-haspopup="true" role="menu" tabindex="0">
Console 
GET _ml/anomaly_detectors/low_request_rate/model_snapshots/_all/_upgrade/_stats

resp = client.ml.get_model_snapshot_upgrade_stats(
    job_id="low_request_rate",
    snapshot_id="_all",
)
const response = await client.ml.getModelSnapshotUpgradeStats({
  job_id: "low_request_rate",
  snapshot_id: "_all",
});
response = client.ml.get_model_snapshot_upgrade_stats(
  job_id: "low_request_rate",
  snapshot_id: "_all"
)
$resp = $client->ml()->getModelSnapshotUpgradeStats([
    "job_id" => "low_request_rate",
    "snapshot_id" => "_all",
]);
curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_ml/anomaly_detectors/low_request_rate/model_snapshots/_all/_upgrade/_stats"
client.ml().getModelSnapshotUpgradeStats(g -> g
    .jobId("low_request_rate")
    .snapshotId("_all")
);