IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Update model snapshots APIedit
Updates certain properties of a snapshot.
Requestedit
POST _ml/anomaly_detectors/<job_id>/model_snapshots/<snapshot_id>/_update
Prerequisitesedit
-
If the Elasticsearch security features are enabled, you must have
manage_ml
ormanage
cluster privileges to use this API. See Security privileges.
Path parametersedit
-
<job_id>
- (Required, string) Identifier for the anomaly detection job.
-
<snapshot_id>
- (Required, string) Identifier for the model snapshot.
Request bodyedit
The following properties can be updated after the model snapshot is created:
-
description
- (Optional, string) A description of the model snapshot. For example, "Before black friday".
-
retain
-
(Optional, boolean) If true, this snapshot will not be deleted during
automatic cleanup of snapshots older than
model_snapshot_retention_days
. Note that this snapshot will still be deleted when the anomaly detection job is deleted. The default value is false.
Examplesedit
The following example updates the snapshot identified as 1491852978
:
POST _ml/anomaly_detectors/it_ops_new_logs/model_snapshots/1491852978/_update { "description": "Snapshot 1", "retain": true }
When the snapshot is updated, you receive the following results:
{ "acknowledged": true, "model": { "job_id": "it_ops_new_logs", "timestamp": 1491852978000, "description": "Snapshot 1", ... "retain": true } }