Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/reference/cat.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,8 @@ include::cat/allocation.asciidoc[]

include::cat/count.asciidoc[]

include::cat/dataframeanalytics.asciidoc[]

include::cat/fielddata.asciidoc[]

include::cat/health.asciidoc[]
Expand Down
165 changes: 165 additions & 0 deletions docs/reference/cat/dataframeanalytics.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
[role="xpack"]
[testenv="platinum"]
[[cat-dfanalytics]]
=== cat {dfanalytics} API
++++
<titleabbrev>cat {dfanalytics}</titleabbrev>
++++

Returns configuration and usage information about {dfanalytics-jobs}.


[[cat-dfanalytics-request]]
==== {api-request-title}

`GET /_cat/ml/data_frame/analytics/<data_frame_analytics_id>` +

`GET /_cat/ml/data_frame/analytics`


[[cat-dfanalytics-prereqs]]
==== {api-prereq-title}

If the {es} {security-features} are enabled, you must have the following
privileges:

* cluster: `monitor_ml`

For more information, see <<security-privileges>> and {ml-docs}/setup.html[Set up {ml-features}].


////
[[cat-dfanalytics-desc]]
==== {api-description-title}

TBD
////

[[cat-dfanalytics-path-params]]
==== {api-path-parms-title}

`<data_frame_analytics_id>`::
(Optional, string)
include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-default]


[[cat-dfanalytics-query-params]]
==== {api-query-parms-title}

include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format]

include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h]

include::{docdir}/rest-api/common-parms.asciidoc[tag=help]

include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s]

include::{docdir}/rest-api/common-parms.asciidoc[tag=time]

include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v]


[[cat-dfanalytics-results]]
==== {api-response-body-title}

`assignment_explanation`::
include::{docdir}/ml/ml-shared.asciidoc[tag=assignment-explanation-dfanalytics]
+
--
To retrieve this information, specify the `ae` column in the `h` query
parameter.
--

`create_time`::
The time when the {dfanalytics-job} was created. To retrieve this information,
specify the `ct` or `createTime` column in the `h` query parameter.

`description`::
include::{docdir}/ml/ml-shared.asciidoc[tag=description-dfa]
+
--
To retrieve this information, specify the `d` column in the `h` query parameter.
--

`dest_index`::
Name of the destination index. To retrieve this information, specify the `di` or
the `destIndex` column in the `h` query parameter.

`failure_reason`::
Contains messages about the reason why a {dfanalytics-job} failed. To retrieve
this information, specify the `fr` or the `failureReason` column in the `h`
query parameter.

`id`::
include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics]
+
--
To retrieve this information, specify the `id` column in the `h` query
parameter.
--

`model_memory_limit`::
The approximate maximum amount of memory resources that are permitted for the
{dfanalytics-job}. To retrieve this information, specify the `mml` or the
`modelMemoryLimit` column in the `h` query parameter.

`node.address`::
The network address of the node that the {dfanalytics-job} is assigned to. To
retrieve this information, specify the `na` or `nodeAddress` column in the `h`
query parameter.

`node.ephemeral_id`::
The ephemeral ID of the node that the {dfanalytics-job} is assigned to. To
retrieve this information, specify the `ne` or `nodeEphemeralId` column in the
`h` query parameter.

`node.id`::
The unique identifier of the node that the {dfanalytics-job} is assigned to. To
retrieve this information, specify the `ni` or `nodeId` column in the `h` query
parameter.

`node.name`::
The name of the node that the {dfanalytics-job} is assigned to. To retrieve this
information, specify the `nn` or `nodeName` column in the `h` query
parameter.

`progress`::
The progress report of the {dfanalytics-job} by phase. To retrieve this
information, specify the `p` column in the `h` query parameter.

`source_index`::
Name of the source index. To retrieve this information, specify the `si` or the
`sourceIndex` column in the `h` query parameter.

`state`::
Current state of the {dfanalytics-job}. To retrieve this information, specify
the `s` column in the `h` query parameter.

`type`::
The type of analysis that the {dfanalytics-job} performs. To retrieve this
information, specify the `t` column in the `h` query parameter.

`version`::
The {es} version number in which the {dfanalytics-job} was created. To retrieve
this information, specify the `v` column in the `h` query parameter.


[[cat-dfanalytics-example]]
==== {api-examples-title}

[source,console]
--------------------------------------------------
GET _cat/ml/data_frame/analytics?v
--------------------------------------------------
// TEST[skip:kibana sample data]

[source,console-result]
----
id create_time type state
classifier_job_1 2020-02-12T11:49:09.594Z classification stopped
classifier_job_2 2020-02-12T11:49:14.479Z classification stopped
classifier_job_3 2020-02-12T11:49:16.928Z classification stopped
classifier_job_4 2020-02-12T11:49:19.127Z classification stopped
classifier_job_5 2020-02-12T11:49:21.349Z classification stopped
----
// TESTRESPONSE[skip:kibana sample data]
4 changes: 4 additions & 0 deletions docs/reference/ml/ml-shared.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,10 @@ tag::analyzed-fields-includes[]
An array of strings that defines the fields that will be included in the analysis.
end::analyzed-fields-includes[]

tag::assignment-explanation-dfanalytics[]
Contains messages relating to the selection of a node.
end::assignment-explanation-dfanalytics[]

tag::background-persist-interval[]
Advanced configuration option. The time between each periodic persistence of the
model. The default value is a randomized value between 3 to 4 hours, which
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"cat.ml_data_frame_analytics":{
"documentation":{
"url":"http://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html"
"url":"http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html"
},
"stability":"stable",
"url":{
Expand Down