2017-06-19 21:23:58 -04:00
|
|
|
[role="xpack"]
|
2017-04-04 18:26:39 -04:00
|
|
|
[[ml-open-job]]
|
2017-12-14 13:52:49 -05:00
|
|
|
=== Open Jobs API
|
|
|
|
++++
|
|
|
|
<titleabbrev>Open Jobs</titleabbrev>
|
|
|
|
++++
|
2017-04-04 18:26:39 -04:00
|
|
|
|
2018-06-13 16:37:35 -04:00
|
|
|
Opens one or more jobs.
|
2017-04-11 21:52:47 -04:00
|
|
|
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.
|
2017-04-04 18:26:39 -04:00
|
|
|
|
2017-04-25 17:08:29 -04:00
|
|
|
|
2017-06-06 16:42:47 -04:00
|
|
|
==== Request
|
2017-04-04 18:26:39 -04:00
|
|
|
|
|
|
|
`POST _xpack/ml/anomaly_detectors/{job_id}/_open`
|
|
|
|
|
2017-04-25 17:08:29 -04:00
|
|
|
|
2017-06-06 16:42:47 -04:00
|
|
|
==== Description
|
2017-04-04 18:26:39 -04:00
|
|
|
|
|
|
|
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.
|
|
|
|
|
2017-04-18 18:13:21 -04:00
|
|
|
|
2017-06-06 16:42:47 -04:00
|
|
|
==== Path Parameters
|
2017-04-04 18:26:39 -04:00
|
|
|
|
|
|
|
`job_id` (required)::
|
2017-04-11 22:26:18 -04:00
|
|
|
(string) Identifier for the job
|
2017-04-04 18:26:39 -04:00
|
|
|
|
2017-04-25 17:08:29 -04:00
|
|
|
|
2017-06-06 16:42:47 -04:00
|
|
|
==== Request Body
|
2017-04-04 18:26:39 -04:00
|
|
|
|
2017-06-28 13:23:32 -04:00
|
|
|
`timeout`::
|
2017-04-11 22:26:18 -04:00
|
|
|
(time) Controls the time to wait until a job has opened.
|
2017-04-06 10:56:46 -04:00
|
|
|
The default value is 30 minutes.
|
2017-04-04 18:26:39 -04:00
|
|
|
|
|
|
|
|
2017-06-06 16:42:47 -04:00
|
|
|
==== Authorization
|
2017-04-25 17:08:29 -04:00
|
|
|
|
|
|
|
You must have `manage_ml`, or `manage` cluster privileges to use this API.
|
2017-06-19 21:23:58 -04:00
|
|
|
For more information, see
|
|
|
|
{xpack-ref}/security-privileges.html[Security Privileges].
|
2017-04-25 17:08:29 -04:00
|
|
|
|
|
|
|
|
2017-06-06 16:42:47 -04:00
|
|
|
==== Examples
|
2017-04-04 18:26:39 -04:00
|
|
|
|
2017-11-28 11:26:58 -05:00
|
|
|
The following example opens the `total-requests` job and sets an optional
|
|
|
|
property:
|
2017-04-04 18:26:39 -04:00
|
|
|
|
|
|
|
[source,js]
|
|
|
|
--------------------------------------------------
|
2017-11-28 11:26:58 -05:00
|
|
|
POST _xpack/ml/anomaly_detectors/total-requests/_open
|
2017-04-04 18:26:39 -04:00
|
|
|
{
|
2017-06-28 13:23:32 -04:00
|
|
|
"timeout": "35m"
|
2017-04-04 18:26:39 -04:00
|
|
|
}
|
|
|
|
--------------------------------------------------
|
|
|
|
// CONSOLE
|
2017-11-28 11:26:58 -05:00
|
|
|
// TEST[setup:server_metrics_job]
|
2017-04-04 18:26:39 -04:00
|
|
|
|
|
|
|
When the job opens, you receive the following results:
|
2017-04-21 11:23:27 -04:00
|
|
|
[source,js]
|
2017-04-04 18:26:39 -04:00
|
|
|
----
|
|
|
|
{
|
|
|
|
"opened": true
|
|
|
|
}
|
|
|
|
----
|
2017-11-28 11:26:58 -05:00
|
|
|
//CONSOLE
|
|
|
|
// TESTRESPONSE
|