IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Get influencers API Get job statistics API »
Elastic Docs ›Elasticsearch Guide [6.5] ›X-Pack APIs ›Machine learning APIs

Get jobs API

edit

Get jobs API

edit

Retrieves configuration information for jobs.

Request

edit

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

Prerequisites

edit

You must have monitor_ml, monitor, manage_ml, or manage cluster privileges to use this API. For more information, see Security privileges.

Description

edit

You can get information for multiple jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can get information for all jobs by using _all, by specifying * as the <job_id>, or by omitting the <job_id>.

This API returns a maximum of 10,000 jobs.

Path parameters

edit
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.

Query parameters

edit
allow_no_jobs

(Optional, 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.

The default value is true, which returns an empty jobs array when there are no matches and the subset of results when there are partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches.

Response body

edit

The API returns the following information:

jobs
(array) An array of job resources. For more information, see Job Resources.

Response codes

edit
404 (Missing resources)
If allow_no_jobs is false, this code indicates that there are no resources that match the request or only partial matches for the request.

Examples

edit

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.3.0",
      "description": "Total sum of requests",
      "create_time": 1517011406091,
      "analysis_config": {
        "bucket_span": "10m",
        "detectors": [
          {
            "detector_description": "Sum of total",
            "function": "sum",
            "field_name": "total",
            "detector_index": 0
          }
        ],
        "influencers": [ ]
      },
      "analysis_limits": {
        "model_memory_limit": "1024mb",
        "categorization_examples_limit": 4
      },
      "data_description": {
        "time_field": "timestamp",
        "time_format": "epoch_ms"
      },
      "model_snapshot_retention_days": 1,
      "results_index_name": "shared"
    }
  ]
}
« Get influencers API Get job statistics API »