Get model snapshots info | Elasticsearch API documentation (v8)

Path parameters

job_idstring Required
Identifier for the anomaly detection job.

Query parameters

descboolean
If true, the results are sorted in descending order.
endstring | number
Returns snapshots with timestamps earlier than this time.
fromnumber
Skips the specified number of snapshots.
sizenumber
Specifies the maximum number of snapshots to obtain.
sortstring
Specifies the sort field for the requested snapshots. By default, the snapshots are sorted by their timestamp.
startstring | number
Returns snapshots with timestamps after this time.

application/json

Body

descboolean
Refer to the description for the desc query parameter.
endstring | number
A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.
One of:
DateTimestring UnitMillisnumber
Time unit for milliseconds
pageobject
Hide page attributes Show page attributes object
- fromnumber
  Skips the specified number of items.
- sizenumber
  Specifies the maximum number of items to obtain.
sortstring
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
startstring | number
A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.
One of:
DateTimestring UnitMillisnumber
Time unit for milliseconds

Responses

200 application/json
Hide response attributes Show response attributes object
- countnumber Required
- model_snapshotsarray[object] Required
  Hide model_snapshots attributes Show model_snapshots attributes object
  descriptionstring
  An optional description of the job.
  job_idstring Required
  latest_record_time_stampnumber
  The timestamp of the latest processed record.
  latest_result_time_stampnumber
  The timestamp of the latest bucket result.
  min_versionstring Required
  model_size_statsobject
  Hide model_size_stats attributes Show model_size_stats attributes object
  bucket_allocation_failures_countnumber Required
  job_idstring Required
  log_timestring | number Required
  A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.
  One of:
  DateTimestring UnitMillisnumber
  Time unit for milliseconds
  memory_statusstring Required
  Values are ok, soft_limit, or hard_limit.
  model_bytesnumber | string Required
  One of:
  ByteSizenumber ByteSizestring
  model_bytes_exceedednumber | string
  One of:
  ByteSizenumber ByteSizestring
  model_bytes_memory_limitnumber | string
  One of:
  ByteSizenumber ByteSizestring
  output_memory_allocator_bytesnumber | string
  One of:
  ByteSizenumber ByteSizestring
  peak_model_bytesnumber | string
  One of:
  ByteSizenumber ByteSizestring
  assignment_memory_basisstring
  result_typestring Required
  total_by_field_countnumber Required
  total_over_field_countnumber Required
  total_partition_field_countnumber Required
  categorization_statusstring Required
  Values are ok or warn.
  categorized_doc_countnumber Required
  dead_category_countnumber Required
  failed_category_countnumber Required
  frequent_category_countnumber Required
  rare_category_countnumber Required
  total_category_countnumber Required
  timestampnumber
  retainboolean Required
  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_countnumber Required
  For .
  snapshot_idstring Required
  timestampnumber Required
  The creation timestamp for the snapshot.

POST /_ml/anomaly_detectors/{job_id}/model_snapshots

curl \
 --request POST 'http://api.example.com/_ml/anomaly_detectors/{job_id}/model_snapshots' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"desc":true,"":"string","page":{"from":42.0,"size":42.0},"sort":"string"}'

Path parameters

Query parameters

Body

endstring | number

startstring | number

Responses

log_timestring | number Required

model_bytesnumber | string Required

model_bytes_exceedednumber | string

model_bytes_memory_limitnumber | string

output_memory_allocator_bytesnumber | string

peak_model_bytesnumber | string