OpenSearch/docs/en/rest-api/ml/get-job.asciidoc

//lcawley Verified example output 2017-04-11
[[ml-get-job]]
==== Get Jobs

The get jobs API enables you to retrieve configuration information for jobs.

===== Request

`GET _xpack/ml/anomaly_detectors/` +

`GET _xpack/ml/anomaly_detectors/<job_id>`

////
===== Description

////
===== Path Parameters

`job_id`::
  (string) Identifier for the job. If you do not specify this optional parameter,
  the API returns information about all jobs that you have authority to view.

===== Results

The API returns the following information:

`jobs`::
  (array) An array of job resources.
  For more information, see <<ml-job-resource,Job Resources>>.

////
===== Responses

200
(EmptyResponse) The cluster has been successfully deleted
404
(BasicFailedReply) The cluster specified by {cluster_id} cannot be found (code: clusters.cluster_not_found)
412
(BasicFailedReply) The Elasticsearch cluster has not been shutdown yet (code: clusters.cluster_plan_state_error)
////
===== Examples

The following example gets configuration information for the `farequote` job:

[source,js]
--------------------------------------------------
GET _xpack/ml/anomaly_detectors/farequote
--------------------------------------------------
// CONSOLE
// TEST[skip:todo]

In this example, the API returns a single result that matches the specified
score and time constraints:
----
{
  "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"
    }
  ]
}
----