mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-18 02:44:49 +00:00
268f5a95af
* [DOCS] Edits for description of ML results resource * [DOCS] Adds Authorization section to ML API pages Original commit: elastic/x-pack-elasticsearch@797761e7ae
51 lines
1.1 KiB
Plaintext
51 lines
1.1 KiB
Plaintext
//lcawley Verified example output 2017-04-11
|
|
[[ml-valid-detector]]
|
|
==== Validate Detectors
|
|
|
|
The validate detectors API validates detector configuration information.
|
|
|
|
===== Request
|
|
|
|
`POST _xpack/ml/anomaly_detectors/_validate/detector`
|
|
|
|
===== Description
|
|
|
|
This API enables you validate the detector configuration before you create a job.
|
|
|
|
|
|
===== Request Body
|
|
|
|
For a list of the properties that you can specify in the body of this API,
|
|
see <<ml-detectorconfig,detector configuration objects>>.
|
|
|
|
|
|
===== 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 detector configuration information:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
POST _xpack/ml/anomaly_detectors/_validate/detector
|
|
{
|
|
"function": "metric",
|
|
"field_name": "responsetime",
|
|
"by_field_name": "airline"
|
|
}
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[skip:todo]
|
|
|
|
When the validation completes, you receive the following results:
|
|
[source,js]
|
|
----
|
|
{
|
|
"acknowledged": true
|
|
}
|
|
----
|