Type to search.

Get data frame analytics jobs

  • GET /_cat/ml/data_frame/analytics/{id}
  • GET /_cat/ml/data_frame/analytics
Auth The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Generally available since 7.7 This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Get configuration and usage information about data frame analytics jobs.

Important

CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get data frame analytics jobs statistics API.

Required privileges

Cluster privileges monitor_ml

Path parameters

id string optional

The ID of the data frame analytics to fetch

Leave it out to use /_cat/ml/data_frame/analytics.

Query parameters

allow_no_match boolean · default: false

Whether to ignore if a wildcard expression matches no configs. (This includes _all string or when no configs have been specified.)

h union oneOf · default: create_time,id,state,type

Comma-separated list of column names to display.

Supported values include:

  • assignment_explanation (or ae): Contains messages relating to the selection of a node.
  • create_time (or ct, createTime): The time when the data frame analytics job was created.
  • description (or d): A description of a job.
  • dest_index (or di, destIndex): Name of the destination index.
  • failure_reason (or fr, failureReason): Contains messages about the reason why a data frame analytics job failed.
  • id: Identifier for the data frame analytics job.
  • model_memory_limit (or mml, modelMemoryLimit): The approximate maximum amount of memory resources that are permitted for the data frame analytics job.
  • node.address (or na, nodeAddress): The network address of the node that the data frame analytics job is assigned to.
  • node.ephemeral_id (or ne, nodeEphemeralId): The ephemeral ID of the node that the data frame analytics job is assigned to.
  • node.id (or ni, nodeId): The unique identifier of the node that the data frame analytics job is assigned to.
  • node.name (or nn, nodeName): The name of the node that the data frame analytics job is assigned to.
  • progress (or p): The progress report of the data frame analytics job by phase.
  • source_index (or si, sourceIndex): Name of the source index.
  • state (or s): Current state of the data frame analytics job.
  • type (or t): The type of analysis that the data frame analytics job performs.
  • version (or v): The Elasticsearch version number in which the data frame analytics job was created.
One of: string[] or string
s union string | string[]

Comma-separated list of column names or column aliases used to sort the response.

Supported values include:

  • assignment_explanation (or ae): Contains messages relating to the selection of a node.
  • create_time (or ct, createTime): The time when the data frame analytics job was created.
  • description (or d): A description of a job.
  • dest_index (or di, destIndex): Name of the destination index.
  • failure_reason (or fr, failureReason): Contains messages about the reason why a data frame analytics job failed.
  • id: Identifier for the data frame analytics job.
  • model_memory_limit (or mml, modelMemoryLimit): The approximate maximum amount of memory resources that are permitted for the data frame analytics job.
  • node.address (or na, nodeAddress): The network address of the node that the data frame analytics job is assigned to.
  • node.ephemeral_id (or ne, nodeEphemeralId): The ephemeral ID of the node that the data frame analytics job is assigned to.
  • node.id (or ni, nodeId): The unique identifier of the node that the data frame analytics job is assigned to.
  • node.name (or nn, nodeName): The name of the node that the data frame analytics job is assigned to.
  • progress (or p): The progress report of the data frame analytics job by phase.
  • source_index (or si, sourceIndex): Name of the source index.
  • state (or s): Current state of the data frame analytics job.
  • type (or t): The type of analysis that the data frame analytics job performs.
  • version (or v): The Elasticsearch version number in which the data frame analytics job was created.
format string · default: text

Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

help boolean · default: false

When set to true will output available columns. This option can't be combined with any other query string option.

v boolean · default: false

When set to true will enable verbose output.

bytes enum

Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

Values: b kb mb gb tb pb
time enum

Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

Values: nanos micros ms s m h d

Response

application/json
<array> object[]
id string

The identifier for the job.

type string

The type of analysis that the job performs.

create_time string

The time when the job was created.

version string

The version of Elasticsearch when the job was created.

source_index string

The name of the source index.

dest_index string

The name of the destination index.

description string

A description of the job.

model_memory_limit string

The approximate maximum amount of memory resources that are permitted for the job.

state string

The current status of the job.

failure_reason string

Messages about the reason why the job failed.

progress string

The progress report for the job by phase.

assignment_explanation string

Messages related to the selection of a node.

node.id string

The unique identifier of the assigned node.

node.name string

The name of the assigned node.

node.ephemeral_id string

The ephemeral identifier of the assigned node.

node.address string

The network address of the assigned node.