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

103 lines
2.4 KiB
Plaintext

[role="xpack"]
[[ml-get-job]]
=== Get Jobs API
++++
<titleabbrev>Get Jobs</titleabbrev>
++++
The get jobs API enables you to retrieve configuration information for jobs.
==== Request
`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`
===== Description
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>`.
==== Path Parameters
`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.
==== Results
The API returns the following information:
`jobs`::
(array) An array of job resources.
For more information, see <<ml-job-resource,Job Resources>>.
==== Authorization
You must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster
privileges to use this API. For more information, see
{xpack-ref}/security-privileges.html[Security Privileges].
==== Examples
The following example gets configuration information for the `farequote` job:
[source,js]
--------------------------------------------------
GET _xpack/ml/anomaly_detectors/farequote
--------------------------------------------------
// CONSOLE
// TEST[skip:todo]
The API returns the following results:
[source,js]
----
{
"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",
"rules": [],
"detector_index": 0
}
],
"influencers": [
"airline"
]
},
"data_description": {
"time_field": "@timestamp",
"time_format": "epoch_ms"
},
"model_snapshot_retention_days": 1,
"model_snapshot_id": "1491948163",
"results_index_name": "shared"
}
]
}
----