Skip to content

Latest commit

 

History

History
145 lines (101 loc) · 3.96 KB

dataframeanalytics.asciidoc

File metadata and controls

145 lines (101 loc) · 3.96 KB

cat {dfanalytics} API

cat {dfanalytics}
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 data frame analytics jobs statistics API.

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

{api-request-title}

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

GET /_cat/ml/data_frame/analytics

{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}.

{api-path-parms-title}

<data_frame_analytics_id>

(Optional, string) {es-repo-dir}/ml/ml-shared.asciidoc

{api-query-parms-title}

+ 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

{es-repo-dir}/ml/ml-shared.asciidoc

create_time, ct, createTime

(Default) The time when the {dfanalytics-job} was created.

description, d

{es-repo-dir}/ml/ml-shared.asciidoc

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) {es-repo-dir}/ml/ml-shared.asciidoc

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.

{api-examples-title}

GET _cat/ml/data_frame/analytics?v=true
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