70 lines
1.6 KiB
Plaintext
70 lines
1.6 KiB
Plaintext
[role="xpack"]
|
|
[testenv="platinum"]
|
|
[[ml-open-job]]
|
|
=== Open jobs API
|
|
++++
|
|
<titleabbrev>Open jobs</titleabbrev>
|
|
++++
|
|
|
|
Opens one or more jobs.
|
|
A job must be opened in order for it to be ready to receive and analyze data.
|
|
A job can be opened and closed multiple times throughout its lifecycle.
|
|
|
|
[[ml-open-job-request]]
|
|
==== {api-request-title}
|
|
|
|
`POST _ml/anomaly_detectors/{job_id}/_open`
|
|
|
|
[[ml-open-job-desc]]
|
|
==== {api-description-title}
|
|
|
|
When you open a new job, it starts with an empty model.
|
|
|
|
When you open an existing job, the most recent model state is automatically loaded.
|
|
The job is ready to resume its analysis from where it left off, once new data is received.
|
|
|
|
[[ml-open-job-path-parms]]
|
|
==== {api-path-parms-title}
|
|
|
|
`job_id` (required)::
|
|
(string) Identifier for the job
|
|
|
|
[[ml-open-job-request-body]]
|
|
==== {api-request-body-title}
|
|
|
|
`timeout`::
|
|
(time) Controls the time to wait until a job has opened.
|
|
The default value is 30 minutes.
|
|
|
|
[[ml-open-job-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
You must have `manage_ml`, or `manage` cluster privileges to use this API.
|
|
For more information, see
|
|
{stack-ov}/security-privileges.html[Security privileges].
|
|
|
|
[[ml-open-job-example]]
|
|
==== {api-examples-title}
|
|
|
|
The following example opens the `total-requests` job and sets an optional
|
|
property:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
POST _ml/anomaly_detectors/total-requests/_open
|
|
{
|
|
"timeout": "35m"
|
|
}
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[skip:setup:server_metrics_job]
|
|
|
|
When the job opens, you receive the following results:
|
|
[source,js]
|
|
----
|
|
{
|
|
"opened": true
|
|
}
|
|
----
|
|
// TESTRESPONSE
|