stack es cat ml-jobs cli command

Auth required Idempotent Scope: global 
elastic stack es cat ml-jobs [options]

Get anomaly detection jobs.

Behaviour flags:

--dry-run — validate all inputs and exit without performing any action

--allow-no-match

Specifies what to do when the request: * Contains wildcard expressions and there are no jobs that match.

  • Contains the _all string or no identifiers and there are no matches.
  • Contains wildcard expressions and there are only partial matches. If true, the API returns an empty jobs array when there are no matches and the subset of results when there are partial matches. If false, the API returns a 404 status code when there are no matches or only partial matches.
--h enum

Comma-separated list of column names to display.

Values: assignment_explanation, buckets.count, buckets.time.exp_avg, buckets.time.exp_avg_hour, buckets.time.max, buckets.time.min, buckets.time.total, data.buckets, data.earliest_record, data.empty_buckets, data.input_bytes, data.input_fields, data.input_records, data.invalid_dates, data.last, data.last_empty_bucket, data.last_sparse_bucket, data.latest_record, data.missing_fields, data.out_of_order_timestamps, data.processed_fields, data.processed_records, data.sparse_buckets, forecasts.memory.avg, forecasts.memory.max, forecasts.memory.min, forecasts.memory.total, forecasts.records.avg, forecasts.records.max, forecasts.records.min, forecasts.records.total, forecasts.time.avg, forecasts.time.max, forecasts.time.min, forecasts.time.total, forecasts.total, id, model.bucket_allocation_failures, model.by_fields, model.bytes, model.bytes_exceeded, model.categorization_status, model.categorized_doc_count, model.dead_category_count, model.failed_category_count, model.frequent_category_count, model.log_time, model.memory_limit, model.memory_status, model.over_fields, model.partition_fields, model.rare_category_count, model.timestamp, model.total_category_count, node.address, node.ephemeral_id, node.id, node.name, opened_time, state

Repeatable: pass --h multiple times to supply more than one value

--s enum

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

Values: assignment_explanation, buckets.count, buckets.time.exp_avg, buckets.time.exp_avg_hour, buckets.time.max, buckets.time.min, buckets.time.total, data.buckets, data.earliest_record, data.empty_buckets, data.input_bytes, data.input_fields, data.input_records, data.invalid_dates, data.last, data.last_empty_bucket, data.last_sparse_bucket, data.latest_record, data.missing_fields, data.out_of_order_timestamps, data.processed_fields, data.processed_records, data.sparse_buckets, forecasts.memory.avg, forecasts.memory.max, forecasts.memory.min, forecasts.memory.total, forecasts.records.avg, forecasts.records.max, forecasts.records.min, forecasts.records.total, forecasts.time.avg, forecasts.time.max, forecasts.time.min, forecasts.time.total, forecasts.total, id, model.bucket_allocation_failures, model.by_fields, model.bytes, model.bytes_exceeded, model.categorization_status, model.categorized_doc_count, model.dead_category_count, model.failed_category_count, model.frequent_category_count, model.log_time, model.memory_limit, model.memory_status, model.over_fields, model.partition_fields, model.rare_category_count, model.timestamp, model.total_category_count, node.address, node.ephemeral_id, node.id, node.name, opened_time, state

Repeatable: pass --s multiple times to supply more than one value

--job-id string
Identifier for the anomaly detection job.
--format string
Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.
--v
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

--error-trace
When set to true Elasticsearch will include the full stack trace of errors when they occur.
--filter-path string

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.

Repeatable: pass --filter-path multiple times to supply more than one value

--human
When set to true will return statistics in a format suitable for humans. For example "exists_time": "1h" for humans and "exists_time_in_millis": 3600000 for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.
--pretty
If set to true the returned JSON will be "pretty-formatted". Only use this option for debugging only.
--input-file string
path to a JSON file to use as command input
--dry-run
validate all inputs and exit without performing any action (preview changes without applying them)
--json

output as JSON