Get model snapshots info
- POST also GET /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}
- POST also GET /_ml/anomaly_detectors/{job_id}/model_snapshots
- Cluster privileges:
monitor_ml
Path Parameters
-
job_idstring Idrequired -
Identifier for the anomaly detection job.
-
snapshot_idstring Idoptional -
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.Leave it out to use
/_ml/anomaly_detectors/{job_id}/model_snapshots.
Query Parameters
-
descboolean · default: false If true, the results are sorted in descending order.
-
endDateTime Returns snapshots with timestamps earlier than this time.
-
fromnumber · default: 0 Skips the specified number of snapshots.
-
sizenumber · default: 100 Specifies the maximum number of snapshots to obtain.
-
sortstring Field Specifies the sort field for the requested snapshots. By default, the snapshots are sorted by their timestamp.
-
startDateTime Returns snapshots with timestamps after this time.
Request
-
descboolean · default: false -
Refer to the description for the
descquery parameter. -
endDateTime -
Refer to the description for the
endquery parameter. -
pagePage -
sortstring Field -
Refer to the description for the
sortquery parameter. -
startDateTime -
Refer to the description for the
startquery parameter.
Response
-
countnumberrequired -
model_snapshotsModelSnapshotrequired -
descriptionstring -
An optional description of the job.
-
job_idstring Idrequired -
A numerical character string that uniquely identifies the job that the snapshot was created for.
-
latest_record_time_stampnumber -
The timestamp of the latest processed record.
-
latest_result_time_stampnumber -
The timestamp of the latest bucket result.
-
min_versionstringrequired -
The minimum version required to be able to restore the model snapshot.
-
model_size_statsModelSizeStats -
Summary information describing the model.
-
bucket_allocation_failures_countnumberrequired -
job_idstring Idrequired -
log_timeDateTimerequired -
memory_statusMemoryStatusrequired -
Values:
oksoft_limithard_limit -
model_bytesnumber | string ByteSizerequired -
model_bytes_exceedednumber | string ByteSize -
model_bytes_memory_limitnumber | string ByteSize -
output_memory_allocator_bytesnumber | string ByteSize -
peak_model_bytesnumber | string ByteSize -
assignment_memory_basisstring -
result_typestringrequired -
total_by_field_countnumberrequired -
total_over_field_countnumberrequired -
total_partition_field_countnumberrequired -
categorization_statusCategorizationStatusrequired -
Values:
okwarn -
categorized_doc_countnumberrequired -
dead_category_countnumberrequired -
failed_category_countnumberrequired -
frequent_category_countnumberrequired -
rare_category_countnumberrequired -
total_category_countnumberrequired -
timestampnumber -
retainbooleanrequired -
If true, this snapshot will not be deleted during automatic cleanup of snapshots older than model_snapshot_retention_days. However, this snapshot will be deleted when the job is deleted. The default value is false.
-
snapshot_doc_countnumberrequired -
For internal use only.
-
snapshot_idstring Idrequired -
A numerical character string that uniquely identifies the model snapshot.
-
timestampnumberrequired -
The creation timestamp for the snapshot.