110 lines
2.3 KiB
Plaintext
110 lines
2.3 KiB
Plaintext
//lcawley Verified example output 2017-04-11
|
|
[[ml-get-datafeed]]
|
|
=== Get {dfeeds-cap}
|
|
|
|
The get {dfeeds} API enables you to retrieve configuration information for
|
|
{dfeeds}.
|
|
|
|
==== Request
|
|
|
|
`GET _xpack/ml/datafeeds/` +
|
|
|
|
`GET _xpack/ml/datafeeds/<feed_id>`
|
|
|
|
//===== Description
|
|
|
|
==== Path Parameters
|
|
|
|
`feed_id`::
|
|
(string) Identifier for the {dfeed}.
|
|
This parameter does not support wildcards, but you can specify `_all` or
|
|
omit the `feed_id` to get information about all {dfeeds}.
|
|
|
|
|
|
==== Results
|
|
|
|
The API returns the following information:
|
|
|
|
`datafeeds`::
|
|
(array) An array of {dfeed} objects.
|
|
For more information, see <<ml-datafeed-resource>>.
|
|
|
|
|
|
==== Authorization
|
|
|
|
You must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster
|
|
privileges to use this API. For more information, see <<privileges-list-cluster>>.
|
|
|
|
|
|
==== Examples
|
|
|
|
The following example gets configuration information for the
|
|
`datafeed-it-ops-kpi` {dfeed}:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET _xpack/ml/datafeeds/datafeed-it-ops-kpi
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[skip:todo]
|
|
|
|
The API returns the following results:
|
|
[source,js]
|
|
----
|
|
{
|
|
"count": 1,
|
|
"datafeeds": [
|
|
{
|
|
"datafeed_id": "datafeed-it-ops-kpi",
|
|
"job_id": "it-ops-kpi",
|
|
"query_delay": "60s",
|
|
"frequency": "150s",
|
|
"indexes": [
|
|
"it_ops_metrics"
|
|
],
|
|
"types": [
|
|
"kpi",
|
|
"network",
|
|
"sql"
|
|
],
|
|
"query": {
|
|
"match_all": {
|
|
"boost": 1
|
|
}
|
|
},
|
|
"aggregations": {
|
|
"buckets": {
|
|
"date_histogram": {
|
|
"field": "@timestamp",
|
|
"interval": 30000,
|
|
"offset": 0,
|
|
"order": {
|
|
"_key": "asc"
|
|
},
|
|
"keyed": false,
|
|
"min_doc_count": 0
|
|
},
|
|
"aggregations": {
|
|
"events_per_min": {
|
|
"sum": {
|
|
"field": "events_per_min"
|
|
}
|
|
},
|
|
"@timestamp": {
|
|
"max": {
|
|
"field": "@timestamp"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"scroll_size": 1000,
|
|
"chunking_config": {
|
|
"mode": "manual",
|
|
"time_span": "30000000ms"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
----
|