122 lines
3.2 KiB
Plaintext
122 lines
3.2 KiB
Plaintext
[role="xpack"]
|
|
[testenv="platinum"]
|
|
[[ml-get-datafeed]]
|
|
=== Get {dfeeds} API
|
|
|
|
[subs="attributes"]
|
|
++++
|
|
<titleabbrev>Get {dfeeds}</titleabbrev>
|
|
++++
|
|
|
|
Retrieves configuration information for {dfeeds}.
|
|
|
|
[[ml-get-datafeed-request]]
|
|
==== {api-request-title}
|
|
|
|
`GET _ml/datafeeds/<feed_id>` +
|
|
|
|
`GET _ml/datafeeds/<feed_id>,<feed_id>` +
|
|
|
|
`GET _ml/datafeeds/` +
|
|
|
|
`GET _ml/datafeeds/_all`
|
|
|
|
[[ml-get-datafeed-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* If the {es} {security-features} are enabled, you must have `monitor_ml`,
|
|
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See
|
|
{stack-ov}/security-privileges.html[Security privileges].
|
|
|
|
[[ml-get-datafeed-desc]]
|
|
==== {api-description-title}
|
|
|
|
You can get information for multiple {dfeeds} in a single API request by using a
|
|
comma-separated list of {dfeeds} or a wildcard expression. You can get
|
|
information for all {dfeeds} by using `_all`, by specifying `*` as the
|
|
`<feed_id>`, or by omitting the `<feed_id>`.
|
|
|
|
IMPORTANT: This API returns a maximum of 10,000 {dfeeds}.
|
|
|
|
[[ml-get-datafeed-path-parms]]
|
|
==== {api-path-parms-title}
|
|
|
|
`<feed_id>`::
|
|
(Optional, string) Identifier for the {dfeed}. It can be a {dfeed} identifier
|
|
or a wildcard expression. If you do not specify one of these options, the API
|
|
returns information about all {dfeeds}.
|
|
|
|
[[ml-get-datafeed-query-parms]]
|
|
==== {api-query-parms-title}
|
|
|
|
`allow_no_datafeeds`::
|
|
(Optional, boolean) Specifies what to do when the request:
|
|
+
|
|
--
|
|
* Contains wildcard expressions and there are no {datafeeds} that match.
|
|
* Contains the `_all` string or no identifiers and there are no matches.
|
|
* Contains wildcard expressions and there are only partial matches.
|
|
|
|
The default value is `true`, which returns an empty `datafeeds` array when
|
|
there are no matches and the subset of results when there are partial matches.
|
|
If this parameter is `false`, the request returns a `404` status code when there
|
|
are no matches or only partial matches.
|
|
--
|
|
|
|
[[ml-get-datafeed-results]]
|
|
==== {api-response-body-title}
|
|
|
|
The API returns the following information:
|
|
|
|
`datafeeds`::
|
|
(array) An array of {dfeed} objects.
|
|
For more information, see <<ml-datafeed-resource>>.
|
|
|
|
[[ml-get-datafeed-response-codes]]
|
|
==== {api-response-codes-title}
|
|
|
|
`404` (Missing resources)::
|
|
If `allow_no_datafeeds` is `false`, this code indicates that there are no
|
|
resources that match the request or only partial matches for the request.
|
|
|
|
[[ml-get-datafeed-example]]
|
|
==== {api-examples-title}
|
|
|
|
The following example gets configuration information for the
|
|
`datafeed-total-requests` {dfeed}:
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
GET _ml/datafeeds/datafeed-total-requests
|
|
--------------------------------------------------
|
|
// TEST[skip:setup:server_metrics_datafeed]
|
|
|
|
The API returns the following results:
|
|
|
|
[source,console-result]
|
|
----
|
|
{
|
|
"count": 1,
|
|
"datafeeds": [
|
|
{
|
|
"datafeed_id": "datafeed-total-requests",
|
|
"job_id": "total-requests",
|
|
"query_delay": "83474ms",
|
|
"indices": [
|
|
"server-metrics"
|
|
],
|
|
"query": {
|
|
"match_all": {
|
|
"boost": 1.0
|
|
}
|
|
},
|
|
"scroll_size": 1000,
|
|
"chunking_config": {
|
|
"mode": "auto"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
----
|
|
// TESTRESPONSE[s/"query.boost": "1.0"/"query.boost": $body.query.boost/]
|