mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-24 23:27:25 -04:00
612ce0f996
* (Doc+) Cross-link CAT APIs to parent object --------- Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
145 lines
4 KiB
Text
145 lines
4 KiB
Text
[role="xpack"]
|
|
[[cat-dfanalytics]]
|
|
=== cat {dfanalytics} API
|
|
++++
|
|
<titleabbrev>cat {dfanalytics}</titleabbrev>
|
|
++++
|
|
|
|
[IMPORTANT]
|
|
====
|
|
cat APIs are only intended for human consumption using the command line or {kib}
|
|
console. They are _not_ intended for use by applications. For application
|
|
consumption, use the
|
|
<<get-dfanalytics-stats,get data frame analytics jobs statistics API>>.
|
|
====
|
|
|
|
Returns configuration and usage information about {ml-docs}/ml-dfanalytics.html[{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-privileges}.
|
|
|
|
|
|
////
|
|
[[cat-dfanalytics-desc]]
|
|
==== {api-description-title}
|
|
////
|
|
|
|
|
|
[[cat-dfanalytics-path-params]]
|
|
==== {api-path-parms-title}
|
|
|
|
`<data_frame_analytics_id>`::
|
|
(Optional, string)
|
|
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics-default]
|
|
|
|
|
|
[[cat-dfanalytics-query-params]]
|
|
==== {api-query-parms-title}
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
|
|
+
|
|
If you do not specify which columns to include, the API returns the default
|
|
columns. If you explicitly specify one or more columns, it returns only the
|
|
specified columns.
|
|
+
|
|
Valid columns are:
|
|
|
|
`assignment_explanation`, `ae`:::
|
|
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=assignment-explanation-dfanalytics]
|
|
|
|
`create_time`, `ct`, `createTime`:::
|
|
(Default)
|
|
The time when the {dfanalytics-job} was created.
|
|
|
|
`description`, `d`:::
|
|
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=description-dfa]
|
|
|
|
`dest_index`, `di`, `destIndex`:::
|
|
Name of the destination index.
|
|
|
|
`failure_reason`, `fr`, `failureReason`:::
|
|
Contains messages about the reason why a {dfanalytics-job} failed.
|
|
|
|
`id`:::
|
|
(Default)
|
|
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics]
|
|
|
|
`model_memory_limit`, `mml`, `modelMemoryLimit`:::
|
|
The approximate maximum amount of memory resources that are permitted for the
|
|
{dfanalytics-job}.
|
|
|
|
`node.address`, `na`, `nodeAddress`:::
|
|
The network address of the node that the {dfanalytics-job} is assigned to.
|
|
|
|
`node.ephemeral_id`, `ne`, `nodeEphemeralId`:::
|
|
The ephemeral ID of the node that the {dfanalytics-job} is assigned to.
|
|
|
|
`node.id`, `ni`, `nodeId`:::
|
|
The unique identifier of the node that the {dfanalytics-job} is assigned to.
|
|
|
|
`node.name`, `nn`, `nodeName`:::
|
|
The name of the node that the {dfanalytics-job} is assigned to.
|
|
|
|
`progress`, `p`:::
|
|
The progress report of the {dfanalytics-job} by phase.
|
|
|
|
`source_index`, `si`, `sourceIndex`:::
|
|
Name of the source index.
|
|
|
|
`state`, `s`:::
|
|
(Default)
|
|
Current state of the {dfanalytics-job}.
|
|
|
|
`type`, `t`:::
|
|
(Default)
|
|
The type of analysis that the {dfanalytics-job} performs.
|
|
|
|
`version`, `v`:::
|
|
The {es} version number in which the {dfanalytics-job} was created.
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=time]
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
|
|
|
|
|
|
[[cat-dfanalytics-example]]
|
|
==== {api-examples-title}
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
GET _cat/ml/data_frame/analytics?v=true
|
|
--------------------------------------------------
|
|
// 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]
|