WARNING: Version 5.4 of the Elastic Stack 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.
Get Jobs
editGet Jobs
editThe get jobs API enables you to retrieve configuration information for jobs.
Path Parameters
edit-
job_id
-
(string) Identifier for the job.
This parameter does not support wildcards, but you can specify
_all
or omit thejob_id
to get information about all jobs.
Results
editThe API returns the following information:
-
jobs
- (array) An array of job resources. For more information, see Job Resources.
Authorization
editYou must have monitor_ml
, monitor
, manage_ml
, or manage
cluster
privileges to use this API. For more information, see Cluster Privileges.
Examples
editThe following example gets configuration information for the farequote
job:
GET _xpack/ml/anomaly_detectors/farequote
The API returns the following results:
{ "count": 1, "jobs": [ { "job_id": "farequote", "job_type": "anomaly_detector", "description": "Multi-metric job", "create_time": 1491948149563, "finished_time": 1491948166289, "analysis_config": { "bucket_span": "5m", "detectors": [ { "detector_description": "mean(responsetime)", "function": "mean", "field_name": "responsetime", "partition_field_name": "airline", "detector_rules": [] } ], "influencers": [ "airline" ] }, "data_description": { "time_field": "@timestamp", "time_format": "epoch_ms" }, "model_snapshot_retention_days": 1, "model_snapshot_id": "1491948163", "results_index_name": "shared" } ] }