OpenSearch/docs/en/rest-api/ml/validate-job.asciidoc

62 lines
1.4 KiB
Plaintext
Raw Normal View History

//lcawley Verified example output 2017-04-11
[[ml-valid-job]]
==== Validate Jobs
The validate jobs API validates job configuration information.
===== Request
`POST _xpack/ml/anomaly_detectors/_validate`
===== Description
This API enables you validate the job configuration before you create the job.
===== Request Body
For a list of the properties that you can specify in the body of this API,
see <<ml-job-resource,Job Resources>>.
===== Authorization
You must have `manage_ml`, or `manage` cluster privileges to use this API.
For more information, see <<privileges-list-cluster>>.
===== Examples
The following example validates job configuration information:
[source,js]
--------------------------------------------------
POST _xpack/ml/anomaly_detectors/_validate
{
"description" : "Unusual response times by airlines",
"analysis_config" : {
"bucket_span": "300S",
"detectors" :[
{
"function": "metric",
"field_name": "responsetime",
"by_field_name": "airline"}],
"influencers": [ "airline" ]
},
"data_description" : {
"time_field": "time",
"time_format": "yyyy-MM-dd'T'HH:mm:ssX"
}
}
--------------------------------------------------
// CONSOLE
// TEST[skip:todo]
When the validation is complete, you receive the following results:
[source,js]
----
{
"acknowledged": true
}
----