123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869 |
- [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.
- ==== Request
- `POST _ml/anomaly_detectors/{job_id}/_open`
- ==== Description
- 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.
- ==== Path Parameters
- `job_id` (required)::
- (string) Identifier for the job
- ==== Request Body
- `timeout`::
- (time) Controls the time to wait until a job has opened.
- The default value is 30 minutes.
- ==== Authorization
- You must have `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 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
|