Get anomaly detection jobs Added in 7.7.0
Returns configuration and usage information for anomaly detection jobs.
This API returns a maximum of 10,000 jobs.
If the Elasticsearch security features are enabled, you must have monitor_ml
,
monitor
, manage_ml
, or manage
cluster privileges to use this API.
CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get anomaly detection job statistics API.
Path parameters
-
Identifier for the anomaly detection job.
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.
If
true
, the API returns an empty jobs array when there are no matches and the subset of results when there are partial matches. Iffalse
, the API returns a 404 status code when there are no matches or only partial matches. -
bytes string
The unit used to display byte values.
Values are
b
,kb
,mb
,gb
,tb
, orpb
. -
h string | array[string]
Comma-separated list of column names to display.
-
s string | array[string]
Comma-separated list of column names or column aliases used to sort the response.
-
time string
The unit used to display time values.
Values are
nanos
,micros
,ms
,s
,m
,h
, ord
.
curl \
-X GET http://api.example.com/_cat/ml/anomaly_detectors/{job_id}
[
{
"id": "string",
"state": "closing",
"opened_time": "string",
"assignment_explanation": "string",
"data.processed_records": "string",
"data.processed_fields": "string",
"": 42.0,
"data.input_records": "string",
"data.input_fields": "string",
"data.invalid_dates": "string",
"data.missing_fields": "string",
"data.out_of_order_timestamps": "string",
"data.empty_buckets": "string",
"data.sparse_buckets": "string",
"data.buckets": "string",
"data.earliest_record": "string",
"data.latest_record": "string",
"data.last": "string",
"data.last_empty_bucket": "string",
"data.last_sparse_bucket": "string",
"model.memory_status": "ok",
"model.memory_limit": "string",
"model.by_fields": "string",
"model.over_fields": "string",
"model.partition_fields": "string",
"model.bucket_allocation_failures": "string",
"model.categorization_status": "ok",
"model.categorized_doc_count": "string",
"model.total_category_count": "string",
"model.frequent_category_count": "string",
"model.rare_category_count": "string",
"model.dead_category_count": "string",
"model.failed_category_count": "string",
"model.log_time": "string",
"model.timestamp": "string",
"forecasts.total": "string",
"forecasts.memory.min": "string",
"forecasts.memory.max": "string",
"forecasts.memory.avg": "string",
"forecasts.memory.total": "string",
"forecasts.records.min": "string",
"forecasts.records.max": "string",
"forecasts.records.avg": "string",
"forecasts.records.total": "string",
"forecasts.time.min": "string",
"forecasts.time.max": "string",
"forecasts.time.avg": "string",
"forecasts.time.total": "string",
"node.id": "string",
"node.name": "string",
"node.ephemeral_id": "string",
"node.address": "string",
"buckets.count": "string",
"buckets.time.total": "string",
"buckets.time.min": "string",
"buckets.time.max": "string",
"buckets.time.exp_avg": "string",
"buckets.time.exp_avg_hour": "string"
}
]