mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-07 21:48:39 +00:00
b41ff62bcc
* [DOCS] Update ML APIs for Elasticsearch Reference * [DOCS] Add X-Pack icon for ML APIs * [DOCS] Add role attribute to ML APIs Original commit: elastic/x-pack-elasticsearch@997ea39759
53 lines
1.1 KiB
Plaintext
53 lines
1.1 KiB
Plaintext
[role="xpack"]
|
|
[[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
|
|
{xpack-ref}/security-privileges.html[Security Privileges].
|
|
//<<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
|
|
}
|
|
----
|