[DOCS] Adds progress parameter description to the GET stats data frame analytics API doc. (#46434)

This commit is contained in:
István Zoltán Szabó 2019-09-06 15:17:18 +02:00
parent 323ec022be
commit 8208ffa666
1 changed files with 24 additions and 0 deletions

View File

@ -24,6 +24,7 @@ experimental[]
`GET _ml/data_frame/analytics/*/_stats`
[[ml-get-dfanalytics-stats-prereq]]
==== {api-prereq-title}
@ -31,6 +32,7 @@ experimental[]
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}
@ -39,6 +41,7 @@ information, see {stack-ov}/security-privileges.html[Security privileges] and
one of these options, the API returns information for the first hundred
{dfanalytics-jobs}.
[[ml-get-dfanalytics-stats-query-params]]
==== {api-query-parms-title}
@ -64,6 +67,7 @@ when there are no matches or only partial matches.
(Optional, integer) Specifies the maximum number of {dfanalytics-jobs} to
obtain. The default value is `100`.
[[ml-get-dfanalytics-stats-response-body]]
==== {api-response-body-title}
@ -72,6 +76,24 @@ 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.
`id`::
(string) The unique identifier of the {dfanalytics-job}.
`state`::
(string) Current state of the {dfanalytics-job}.
`progress`::
(array) The progress report of the {dfanalytics-job} by phase.
`phase`::
(string) Defines the phase of the {dfanalytics-job}. Possible phases:
`reindexing`, `loading_data`, `analyzing`, and `writing_results`.
`progress_percent`::
(integer) The progress that the {dfanalytics-job} has made expressed in
percentage.
[[ml-get-dfanalytics-stats-response-codes]]
==== {api-response-codes-title}
@ -80,6 +102,7 @@ The API returns the following information:
If `allow_no_match` is `false`, this code indicates that there are no
resources that match the request or only partial matches for the request.
[[ml-get-dfanalytics-stats-example]]
==== {api-examples-title}
@ -90,6 +113,7 @@ GET _ml/data_frame/analytics/loganalytics/_stats
// CONSOLE
// TEST[skip:TBD]
The API returns the following results:
[source,js]