WARNING: Version 5.4 of the Elastic Stack has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Open Jobs
editOpen Jobs
editA 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
editPOST _xpack/ml/anomaly_detectors/{job_id}/_open
Description
editA job must be open in order to it to accept and analyze data.
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
edit-
job_id(required) - (string) Identifier for the job
Request Body
edit-
timeout - (time) Controls the time to wait until a job has opened. The default value is 30 minutes.
-
ignore_downtime - [preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. (boolean) If true (default), any gap in data since it was last closed is treated as a maintenance window. That is to say, it is not an anomaly
Authorization
editYou must have manage_ml, or manage cluster privileges to use this API.
For more information, see Cluster Privileges.
Examples
editThe following example opens the event_rate job and sets an optional property:
POST _xpack/ml/anomaly_detectors/event_rate/_open
{
"timeout": "35m"
}
When the job opens, you receive the following results:
{
"opened": true
}