mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-04-10 09:18:29 +00:00
7242267f5d
This PR adds the reference documentation pages of the data frame analytics APIs (PUT, START, STOP, GET, GET stats, DELETE, Evaluate) to the ML APIs pool.
92 lines
2.3 KiB
Plaintext
92 lines
2.3 KiB
Plaintext
[role="xpack"]
|
|
[testenv="platinum"]
|
|
[[get-dfanalytics-stats]]
|
|
=== Get {dfanalytics-jobs} statistics API
|
|
[subs="attributes"]
|
|
++++
|
|
<titleabbrev>Get {dfanalytics-jobs} stats</titleabbrev>
|
|
++++
|
|
|
|
experimental[]
|
|
|
|
Retrieves usage information for {dfanalytics-jobs}.
|
|
|
|
[[ml-get-dfanalytics-stats-request]]
|
|
==== {api-request-title}
|
|
|
|
`GET _ml/data_frame/analytics/<data_frame_analytics_id>/_stats` +
|
|
|
|
`GET _ml/data_frame/analytics/<data_frame_analytics_id>,<data_frame_analytics_id>/_stats` +
|
|
|
|
`GET _ml/data_frame/analytics/_stats` +
|
|
|
|
`GET _ml/data_frame/analytics/_all/_stats` +
|
|
|
|
`GET _ml/data_frame/analytics/*/_stats`
|
|
|
|
[[ml-get-dfanalytics-stats-prereq]]
|
|
==== {api-prereq-title}
|
|
|
|
* You must have `monitor_ml` privilege to use this API. For more
|
|
information, see {stack-ov}/security-privileges.html[Security privileges] and
|
|
{stack-ov}/built-in-roles.html[Built-in roles].
|
|
|
|
[[ml-get-dfanalytics-stats-path-params]]
|
|
==== {api-path-parms-title}
|
|
|
|
`<data_frame_analytics_id>` (Optional)::
|
|
(string) Identifier for the {dfanalytics-job}. If you do not specify one of
|
|
these options, the API returns information for the first hundred
|
|
{dfanalytics-jobs}.
|
|
|
|
`allow_no_match` (Optional)
|
|
(boolean) If `false` and the `data_frame_analytics_id` does not match any
|
|
{dfanalytics-job} an error will be returned. The default value is `true`.
|
|
|
|
[[ml-get-dfanalytics-stats-query-params]]
|
|
==== {api-query-parms-title}
|
|
|
|
`from` (Optional)::
|
|
(integer) Skips the specified number of {dfanalytics-jobs}. The default value
|
|
is `0`.
|
|
|
|
`size` (Optional)::
|
|
(integer) Specifies the maximum number of {dfanalytics-jobs} to obtain. The
|
|
default value is `100`.
|
|
|
|
[discrete]
|
|
[[ml-get-dfanalytics-stats-response-body]]
|
|
==== {api-response-body-title}
|
|
|
|
The API returns the following information:
|
|
|
|
`data_frame_analytics`::
|
|
(array) An array of statistics objects for {dfanalytics-jobs}, which are
|
|
sorted by the `id` value in ascending order.
|
|
|
|
[[ml-get-dfanalytics-stats-example]]
|
|
==== {api-examples-title}
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET _ml/data_frame/analytics/loganalytics/_stats
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[skip:TBD]
|
|
|
|
The API returns the following results:
|
|
|
|
[source,js]
|
|
----
|
|
{
|
|
"count": 1,
|
|
"data_frame_analytics": [
|
|
{
|
|
"id": "loganalytics",
|
|
"state": "stopped"
|
|
}
|
|
]
|
|
}
|
|
----
|
|
// TESTRESPONSE
|