WARNING: Version 6.2 of Elasticsearch has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
This API enables you to retrieve configuration information for jobs.
GET _xpack/ml/anomaly_detectors/<job_id>
GET _xpack/ml/anomaly_detectors/<job_id>,<job_id>
GET _xpack/ml/anomaly_detectors/
GET _xpack/ml/anomaly_detectors/_all
-
job_id - (string) Identifier for the job. It can be a job identifier, a group name, or a wildcard expression. If you do not specify one of these options, the API returns information for all jobs.
The API returns the following information:
-
jobs - (array) An array of job resources. For more information, see Job Resources.
You must have monitor_ml, monitor, manage_ml, or manage cluster
privileges to use this API. For more information, see
Security Privileges.
The following example gets configuration information for the total-requests job:
GET _xpack/ml/anomaly_detectors/total-requests
The API returns the following results:
{
"count": 1,
"jobs": [
{
"job_id": "total-requests",
"job_type": "anomaly_detector",
"job_version": "6.2.2",
"description": "Total sum of requests",
"create_time": 1518550271488,
"analysis_config": {
"bucket_span": "10m",
"detectors": [
{
"detector_description": "Sum of total",
"function": "sum",
"field_name": "total",
"rules": [ ],
"detector_index": 0
}
],
"influencers": [ ]
},
"analysis_limits": {
"model_memory_limit": "1024mb"
},
"data_description": {
"time_field": "timestamp",
"time_format": "epoch_ms"
},
"model_snapshot_retention_days": 1,
"results_index_name": "shared"
}
]
}