mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-08 22:14:59 +00:00
[DOCS] Adds allow no datafeeds query param to the GET, GET stats and STOP datafeed APIs (#44499)
This commit is contained in:
parent
2ca6306452
commit
4a31c426e6
@ -49,6 +49,24 @@ IMPORTANT: This API returns a maximum of 10,000 {dfeeds}.
|
|||||||
or a wildcard expression. If you do not specify one of these options, the API
|
or a wildcard expression. If you do not specify one of these options, the API
|
||||||
returns statistics for all {dfeeds}.
|
returns statistics for all {dfeeds}.
|
||||||
|
|
||||||
|
[[ml-get-datafeed-stats-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-stats-results]]
|
[[ml-get-datafeed-stats-results]]
|
||||||
==== {api-response-body-title}
|
==== {api-response-body-title}
|
||||||
|
|
||||||
@ -58,6 +76,13 @@ The API returns the following information:
|
|||||||
(array) An array of {dfeed} count objects.
|
(array) An array of {dfeed} count objects.
|
||||||
For more information, see <<ml-datafeed-counts>>.
|
For more information, see <<ml-datafeed-counts>>.
|
||||||
|
|
||||||
|
[[ml-get-datafeed-stats-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-stats-example]]
|
[[ml-get-datafeed-stats-example]]
|
||||||
==== {api-examples-title}
|
==== {api-examples-title}
|
||||||
|
|
||||||
|
@ -46,6 +46,23 @@ IMPORTANT: This API returns a maximum of 10,000 {dfeeds}.
|
|||||||
or a wildcard expression. If you do not specify one of these options, the API
|
or a wildcard expression. If you do not specify one of these options, the API
|
||||||
returns information about all {dfeeds}.
|
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]]
|
[[ml-get-datafeed-results]]
|
||||||
==== {api-response-body-title}
|
==== {api-response-body-title}
|
||||||
|
|
||||||
@ -55,6 +72,13 @@ The API returns the following information:
|
|||||||
(array) An array of {dfeed} objects.
|
(array) An array of {dfeed} objects.
|
||||||
For more information, see <<ml-datafeed-resource>>.
|
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]]
|
[[ml-get-datafeed-example]]
|
||||||
==== {api-examples-title}
|
==== {api-examples-title}
|
||||||
|
|
||||||
|
@ -43,6 +43,23 @@ comma-separated list of {dfeeds} or a wildcard expression. You can close all
|
|||||||
(Required, string) Identifier for the {dfeed}. It can be a {dfeed} identifier
|
(Required, string) Identifier for the {dfeed}. It can be a {dfeed} identifier
|
||||||
or a wildcard expression.
|
or a wildcard expression.
|
||||||
|
|
||||||
|
[[ml-stop-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-stop-datafeed-request-body]]
|
[[ml-stop-datafeed-request-body]]
|
||||||
==== {api-request-body-title}
|
==== {api-request-body-title}
|
||||||
|
|
||||||
@ -53,6 +70,13 @@ comma-separated list of {dfeeds} or a wildcard expression. You can close all
|
|||||||
(Optional, time) Controls the amount of time to wait until a {dfeed} stops.
|
(Optional, time) Controls the amount of time to wait until a {dfeed} stops.
|
||||||
The default value is 20 seconds.
|
The default value is 20 seconds.
|
||||||
|
|
||||||
|
[[ml-stop-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-stop-datafeed-example]]
|
[[ml-stop-datafeed-example]]
|
||||||
==== {api-examples-title}
|
==== {api-examples-title}
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user