117 lines
2.5 KiB
Plaintext
117 lines
2.5 KiB
Plaintext
//lcawley Verified example output 2017-04-11
|
|
[[ml-put-datafeed]]
|
|
==== Create Data Feeds
|
|
|
|
The create data feed API enables you to instantiate a data feed.
|
|
|
|
===== Request
|
|
|
|
`PUT _xpack/ml/datafeeds/<feed_id>`
|
|
|
|
===== Description
|
|
|
|
You must create a job before you create a data feed. You can associate only one
|
|
data feed to each job.
|
|
|
|
You must have `manage_ml`, or `manage` cluster privileges to use this API.
|
|
For more information, see <<privileges-list-cluster>>.
|
|
|
|
===== Path Parameters
|
|
|
|
`feed_id` (required)::
|
|
(string) A numerical character string that uniquely identifies the data feed.
|
|
|
|
===== Request Body
|
|
|
|
`aggregations`::
|
|
(object) TBD.
|
|
|
|
`chunking_config`::
|
|
(object) TBD.
|
|
For example: {"mode": "manual", "time_span": "30000000ms"}
|
|
|
|
`frequency`::
|
|
TBD: For example: "150s"
|
|
|
|
`indexes` (required)::
|
|
(array) An array of index names. For example: ["it_ops_metrics"]
|
|
|
|
`job_id` (required)::
|
|
(string) A numerical character string that uniquely identifies the job.
|
|
|
|
`query`::
|
|
(object) The query that retrieves the data.
|
|
By default, this property has the following value: `{"match_all": {"boost": 1}}`.
|
|
|
|
`query_delay`::
|
|
TBD. For example: "60s"
|
|
|
|
`scroll_size`::
|
|
TBD. For example, 1000
|
|
|
|
`types` (required)::
|
|
TBD. For example: ["network","sql","kpi"]
|
|
|
|
For more information about these properties,
|
|
see <<ml-datafeed-resource, Data Feed Resources>>.
|
|
|
|
////
|
|
===== Responses
|
|
|
|
TBD
|
|
200
|
|
(EmptyResponse) The cluster has been successfully deleted
|
|
404
|
|
(BasicFailedReply) The cluster specified by {cluster_id} cannot be found (code: clusters.cluster_not_found)
|
|
412
|
|
(BasicFailedReply) The Elasticsearch cluster has not been shutdown yet (code: clusters.cluster_plan_state_error)
|
|
|
|
////
|
|
===== Examples
|
|
|
|
The following example creates the `datafeed-it-ops-kpi` data feed:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
PUT _xpack/ml/datafeeds/datafeed-it-ops-kpi
|
|
{
|
|
"job_id": "it-ops-kpi",
|
|
"indexes": ["it_ops_metrics"],
|
|
"types": ["kpi","network","sql"],
|
|
"query": {
|
|
"match_all": {
|
|
"boost": 1
|
|
}
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[skip:todo]
|
|
|
|
When the data feed is created, you receive the following results:
|
|
[source,js]
|
|
----
|
|
{
|
|
"datafeed_id": "datafeed-it-ops-kpi",
|
|
"job_id": "it-ops-kpi",
|
|
"query_delay": "1m",
|
|
"indexes": [
|
|
"it_ops_metrics"
|
|
],
|
|
"types": [
|
|
"kpi",
|
|
"network",
|
|
"sql"
|
|
],
|
|
"query": {
|
|
"match_all": {
|
|
"boost": 1
|
|
}
|
|
},
|
|
"scroll_size": 1000,
|
|
"chunking_config": {
|
|
"mode": "auto"
|
|
}
|
|
}
|
|
----
|