Query parameters

• allow_no_match boolean

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

• bytes string

  The unit in which to display byte values

  Values are b, kb, mb, gb, tb, or pb.

• h string | array[string]

  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.

  Values are assignment_explanation, ae, create_time, ct, createTime, description, d, dest_index, di, destIndex, failure_reason, fr, failureReason, id, model_memory_limit, mml, modelMemoryLimit, node.address, na, nodeAddress, node.ephemeral_id, ne, nodeEphemeralId, node.id, ni, nodeId, node.name, nn, nodeName, progress, p, source_index, si, sourceIndex, state, s, type, t, version, or v.

• s string | array[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.

  Values are assignment_explanation, ae, create_time, ct, createTime, description, d, dest_index, di, destIndex, failure_reason, fr, failureReason, id, model_memory_limit, mml, modelMemoryLimit, node.address, na, nodeAddress, node.ephemeral_id, ne, nodeEphemeralId, node.id, ni, nodeId, node.name, nn, nodeName, progress, p, source_index, si, sourceIndex, state, s, type, t, version, or v.

• time string

  Unit used to display time values.

  Values are nanos, micros, ms, s, m, h, or d.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • id string
  • type string

    The type of analysis that the job performs.

  • create_time string

    The time when the job was created.

  • version string
  • source_index string
  • dest_index string
  • 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
  • node.name string
  • node.ephemeral_id string
  • node.address string

    The network address of the assigned node.