79 lines
1.7 KiB
Plaintext
79 lines
1.7 KiB
Plaintext
[role="xpack"]
|
|
[testenv="platinum"]
|
|
[[ml-update-snapshot]]
|
|
=== Update Model Snapshots API
|
|
++++
|
|
<titleabbrev>Update Model Snapshots</titleabbrev>
|
|
++++
|
|
|
|
Updates certain properties of a snapshot.
|
|
|
|
==== Request
|
|
|
|
`POST _ml/anomaly_detectors/<job_id>/model_snapshots/<snapshot_id>/_update`
|
|
|
|
|
|
//==== Description
|
|
|
|
==== Path Parameters
|
|
|
|
`job_id` (required)::
|
|
(string) Identifier for the job
|
|
|
|
`snapshot_id` (required)::
|
|
(string) Identifier for the model snapshot
|
|
|
|
==== Request Body
|
|
|
|
The following properties can be updated after the model snapshot is created:
|
|
|
|
`description`::
|
|
(string) An optional description of the model snapshot. For example,
|
|
"Before black friday".
|
|
|
|
`retain`::
|
|
(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 job is deleted.
|
|
The default value is false.
|
|
|
|
|
|
==== Authorization
|
|
|
|
You must have `manage_ml`, or `manage` cluster privileges to use this API.
|
|
For more information, see
|
|
{xpack-ref}/security-privileges.html[Security Privileges].
|
|
//<<privileges-list-cluster>>.
|
|
|
|
|
|
==== Examples
|
|
|
|
The following example updates the snapshot identified as `1491852978`:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
POST
|
|
_ml/anomaly_detectors/it_ops_new_logs/model_snapshots/1491852978/_update
|
|
{
|
|
"description": "Snapshot 1",
|
|
"retain": true
|
|
}
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[skip:todo]
|
|
|
|
When the snapshot is updated, you receive the following results:
|
|
[source,js]
|
|
----
|
|
{
|
|
"acknowledged": true,
|
|
"model": {
|
|
"job_id": "it_ops_new_logs",
|
|
"timestamp": 1491852978000,
|
|
"description": "Snapshot 1",
|
|
...
|
|
"retain": true
|
|
}
|
|
}
|
|
----
|