WARNING: Version 6.1 of Elasticsearch 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.
This API enables you to instantiate a job.
-
job_id(required) - (string) Identifier for the job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.
-
analysis_config - (object) The analysis configuration, which specifies how to analyze the data. See analysis configuration objects.
-
analysis_limits - (object) Specifies runtime limits for the job. See analysis limits.
-
background_persist_interval - (time units) Advanced configuration option. The time between each periodic persistence of the model. See Job Resources.
-
custom_settings - (object) Advanced configuration option. Contains custom meta data about the job. See Job Resources.
-
data_description(required) -
(object) Describes the format of the input data. This object is required, but
it can be empty (
{}). See data description objects. -
description - (string) A description of the job.
-
groups - (array of strings) A list of job groups. See Job Resources.
-
model_plot_config - (object) Advanced configuration option. Specifies to store model information along with the results. This adds overhead to the performance of the system and is not feasible for jobs with many entities, see Model Plot Config.
-
model_snapshot_retention_days -
(long) The time in days that model snapshots are retained for the job.
Older snapshots are deleted. The default value is
1, which means snapshots are retained for one day (twenty-four hours). -
renormalization_window_days - (long) Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. See Job Resources.
-
results_index_name -
(string) A text string that affects the name of the machine learning results index. The
default value is
shared, which generates an index named.ml-anomalies-shared. -
results_retention_days - (long) Advanced configuration option. The number of days for which job results are retained. See Job Resources.
You must have manage_ml, or manage cluster privileges to use this API.
For more information, see
Security Privileges.
The following example creates the it-ops-kpi job:
PUT _xpack/ml/anomaly_detectors/it-ops-kpi
{
"description":"First simple job",
"analysis_config":{
"bucket_span": "5m",
"latency": "0ms",
"detectors":[
{
"detector_description": "low_sum(events_per_min)",
"function":"low_sum",
"field_name": "events_per_min"
}
]
},
"data_description": {
"time_field":"@timestamp",
"time_format":"epoch_ms"
}
}
When the job is created, you receive the following results:
{
"job_id": "it-ops-kpi",
"job_type": "anomaly_detector",
"job_version": "6.1.0",
"description": "First simple job",
"create_time": 1503076137005,
"analysis_config": {
"bucket_span": "5m",
"latency": "0ms",
"detectors": [
{
"detector_description": "low_sum(events_per_min)",
"function": "low_sum",
"field_name": "events_per_min",
"detector_rules": [],
"detector_index": 0
}
],
"influencers": []
},
"analysis_limits": {
"model_memory_limit": "1024mb"
},
"data_description": {
"time_field": "@timestamp",
"time_format": "epoch_ms"
},
"model_snapshot_retention_days": 1,
"results_index_name": "shared"
}