Get anomaly detection job model snapshot upgrade usage info

GET /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade/_stats

Auth

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.

Response

application/json

count number required
model_snapshot_upgrades object[] required

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

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

JavaScript Elasticsearch JavaScript Client

const response = await client.ml.getModelSnapshotUpgradeStats({
  job_id: "low_request_rate",
  snapshot_id: "_all",
});

Python Elasticsearch Python Client

resp = client.ml.get_model_snapshot_upgrade_stats(
    job_id="low_request_rate",
    snapshot_id="_all",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_ml/anomaly_detectors/low_request_rate/model_snapshots/_all/_upgrade/_stats" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.ml().getModelSnapshotUpgradeStats(g -> g
    .jobId("low_request_rate")
    .snapshotId("_all")
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning.GetModelSnapshotUpgradeStatsAsync(jobId: "low_request_rate", snapshotId: "_all");

PHP Elasticsearch PHP Client

$resp = $client->ml()->getModelSnapshotUpgradeStats([
    "job_id" => "low_request_rate",
    "snapshot_id" => "_all",
]);

Ruby Elasticsearch Ruby Client

response = client.ml.get_model_snapshot_upgrade_stats(
  job_id: "low_request_rate",
  snapshot_id: "_all"
)

Response

{
  "count": 0,
  "model_snapshot_upgrades": [
    {
      "job_id": "string",
      "snapshot_id": "string",
      "state": "loading_old_state",
      "node": {
        "key": {
          "name": "string",
          "ephemeral_id": "string",
          "transport_address": "string",
          "external_id": "string",
          "attributes": {
            "key": "string"
          },
          "roles": [
            "string"
          ],
          "version": "string",
          "min_index_version": 0,
          "max_index_version": 0
        }
      },
      "assignment_explanation": "string"
    }
  ]
}

Generated from the API spec