Cat

class elasticsearch.client.CatClient(client)
Parameters:

client (BaseClient)

aliases(*, name=None, error_trace=None, expand_wildcards=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, v=None)

Shows information about currently configured aliases to indices including filter and routing infos.

https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-alias.html

Parameters:
  • name (str | Sequence[str] | None) – A comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all.

  • expand_wildcards (Sequence[Literal['all', 'closed', 'hidden', 'none', 'open'] | str] | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | str | None) – Whether to expand wildcard expression to concrete indices that are open, closed or both.

  • format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

  • h (str | Sequence[str] | None) – List of columns to appear in the response. Supports simple wildcards.

  • help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

  • local (bool | None) – If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

  • master_timeout (Literal[-1] | ~typing.Literal[0] | str | None) – Period to wait for a connection to the master node.

  • s (str | Sequence[str] | None) – List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

  • v (bool | None) – When set to true will enable verbose output.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any] | TextApiResponse

allocation(*, node_id=None, bytes=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, v=None)

Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.

https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-allocation.html

Parameters:
  • node_id (str | Sequence[str] | None) – Comma-separated list of node identifiers or names used to limit the returned information.

  • bytes (Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | str | None) – The unit used to display byte values.

  • format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

  • h (str | Sequence[str] | None) – List of columns to appear in the response. Supports simple wildcards.

  • help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

  • local (bool | None) – If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

  • master_timeout (Literal[-1] | ~typing.Literal[0] | str | None) – Period to wait for a connection to the master node.

  • s (str | Sequence[str] | None) – List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

  • v (bool | None) – When set to true will enable verbose output.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any] | TextApiResponse

component_templates(*, name=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, v=None)

Returns information about existing component_templates templates.

https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-component-templates.html

Parameters:
  • name (str | None) – The name of the component template. Accepts wildcard expressions. If omitted, all component templates are returned.

  • format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

  • h (str | Sequence[str] | None) – List of columns to appear in the response. Supports simple wildcards.

  • help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

  • local (bool | None) – If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

  • master_timeout (Literal[-1] | ~typing.Literal[0] | str | None) – Period to wait for a connection to the master node.

  • s (str | Sequence[str] | None) – List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

  • v (bool | None) – When set to true will enable verbose output.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any] | TextApiResponse

count(*, index=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, v=None)

Provides quick access to the document count of the entire cluster, or individual indices.

https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-count.html

Parameters:
  • index (str | Sequence[str] | None) – Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

  • format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

  • h (str | Sequence[str] | None) – List of columns to appear in the response. Supports simple wildcards.

  • help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

  • local (bool | None) – If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

  • master_timeout (Literal[-1] | ~typing.Literal[0] | str | None) – Period to wait for a connection to the master node.

  • s (str | Sequence[str] | None) – List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

  • v (bool | None) – When set to true will enable verbose output.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any] | TextApiResponse

fielddata(*, fields=None, bytes=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, v=None)

Shows how much heap memory is currently being used by fielddata on every data node in the cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-fielddata.html

Parameters:
  • fields (str | Sequence[str] | None) – Comma-separated list of fields used to limit returned information. To retrieve all fields, omit this parameter.

  • bytes (Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | str | None) – The unit used to display byte values.

  • format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

  • h (str | Sequence[str] | None) – List of columns to appear in the response. Supports simple wildcards.

  • help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

  • local (bool | None) – If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

  • master_timeout (Literal[-1] | ~typing.Literal[0] | str | None) – Period to wait for a connection to the master node.

  • s (str | Sequence[str] | None) – List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

  • v (bool | None) – When set to true will enable verbose output.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any] | TextApiResponse

health(*, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, time=None, ts=None, v=None)

Returns a concise representation of the cluster health.

https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-health.html

Parameters:
  • format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

  • h (str | Sequence[str] | None) – List of columns to appear in the response. Supports simple wildcards.

  • help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

  • local (bool | None) – If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

  • master_timeout (Literal[-1] | ~typing.Literal[0] | str | None) – Period to wait for a connection to the master node.

  • s (str | Sequence[str] | None) – List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

  • time (Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | str | None) – The unit used to display time values.

  • ts (bool | None) – If true, returns HH:MM:SS and Unix epoch timestamps.

  • v (bool | None) – When set to true will enable verbose output.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any] | TextApiResponse

help(*, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, v=None)

Returns help for the Cat APIs.

https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat.html

Parameters:
  • format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

  • h (str | Sequence[str] | None) – List of columns to appear in the response. Supports simple wildcards.

  • help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

  • local (bool | None) – If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

  • master_timeout (Literal[-1] | ~typing.Literal[0] | str | None) – Period to wait for a connection to the master node.

  • s (str | Sequence[str] | None) – List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

  • v (bool | None) – When set to true will enable verbose output.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

TextApiResponse

indices(*, index=None, bytes=None, error_trace=None, expand_wildcards=None, filter_path=None, format=None, h=None, health=None, help=None, human=None, include_unloaded_segments=None, local=None, master_timeout=None, pretty=None, pri=None, s=None, time=None, v=None)

Returns information about indices: number of primaries and replicas, document counts, disk size, …

https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-indices.html

Parameters:
  • index (str | Sequence[str] | None) – Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

  • bytes (Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | str | None) – The unit used to display byte values.

  • expand_wildcards (Sequence[Literal['all', 'closed', 'hidden', 'none', 'open'] | str] | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | str | None) – The type of index that wildcard patterns can match.

  • format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

  • h (str | Sequence[str] | None) – List of columns to appear in the response. Supports simple wildcards.

  • health (Literal['green', 'red', 'yellow'] | str | None) – The health status used to limit returned indices. By default, the response includes indices of any health status.

  • help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

  • include_unloaded_segments (bool | None) – If true, the response includes information from segments that are not loaded into memory.

  • local (bool | None) – If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

  • master_timeout (Literal[-1] | ~typing.Literal[0] | str | None) – Period to wait for a connection to the master node.

  • pri (bool | None) – If true, the response only includes information from primary shards.

  • s (str | Sequence[str] | None) – List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

  • time (Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | str | None) – The unit used to display time values.

  • v (bool | None) – When set to true will enable verbose output.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any] | TextApiResponse

master(*, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, v=None)

Returns information about the master node.

https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-master.html

Parameters:
  • format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

  • h (str | Sequence[str] | None) – List of columns to appear in the response. Supports simple wildcards.

  • help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

  • local (bool | None) – If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

  • master_timeout (Literal[-1] | ~typing.Literal[0] | str | None) – Period to wait for a connection to the master node.

  • s (str | Sequence[str] | None) – List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

  • v (bool | None) – When set to true will enable verbose output.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any] | TextApiResponse

ml_data_frame_analytics(*, id=None, allow_no_match=None, bytes=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, time=None, v=None)

Gets configuration and usage information about data frame analytics jobs.

https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-dfanalytics.html

Parameters:
  • id (str | None) – The ID of the data frame analytics to fetch

  • allow_no_match (bool | None) – Whether to ignore if a wildcard expression matches no configs. (This includes _all string or when no configs have been specified)

  • bytes (Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | str | None) – The unit in which to display byte values

  • format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

  • h (Sequence[Literal['assignment_explanation', 'create_time', 'description', 'dest_index', 'failure_reason', 'id', 'model_memory_limit', 'node.address', 'node.ephemeral_id', 'node.id', 'node.name', 'progress', 'source_index', 'state', 'type', 'version'] | str] | ~typing.Literal['assignment_explanation', 'create_time', 'description', 'dest_index', 'failure_reason', 'id', 'model_memory_limit', 'node.address', 'node.ephemeral_id', 'node.id', 'node.name', 'progress', 'source_index', 'state', 'type', 'version'] | str | None) – Comma-separated list of column names to display.

  • help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

  • local (bool | None) – If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

  • master_timeout (Literal[-1] | ~typing.Literal[0] | str | None) – Period to wait for a connection to the master node.

  • s (Sequence[Literal['assignment_explanation', 'create_time', 'description', 'dest_index', 'failure_reason', 'id', 'model_memory_limit', 'node.address', 'node.ephemeral_id', 'node.id', 'node.name', 'progress', 'source_index', 'state', 'type', 'version'] | str] | ~typing.Literal['assignment_explanation', 'create_time', 'description', 'dest_index', 'failure_reason', 'id', 'model_memory_limit', 'node.address', 'node.ephemeral_id', 'node.id', 'node.name', 'progress', 'source_index', 'state', 'type', 'version'] | str | None) – Comma-separated list of column names or column aliases used to sort the response.

  • time (Literal[-1] | ~typing.Literal[0] | str | None) – Unit used to display time values.

  • v (bool | None) – When set to true will enable verbose output.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any] | TextApiResponse

ml_datafeeds(*, datafeed_id=None, allow_no_match=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, time=None, v=None)

Gets configuration and usage information about datafeeds.

https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-datafeeds.html

Parameters:
  • datafeed_id (str | None) – A numerical character string that uniquely identifies the datafeed.

  • allow_no_match (bool | None) – Specifies what to do when the request: * Contains wildcard expressions and there are no datafeeds 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 datafeeds 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.

  • format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

  • h (Sequence[Literal['ae', 'bc', 'id', 'na', 'ne', 'ni', 'nn', 's', 'sba', 'sc', 'seah', 'st'] | str] | ~typing.Literal['ae', 'bc', 'id', 'na', 'ne', 'ni', 'nn', 's', 'sba', 'sc', 'seah', 'st'] | str | None) – Comma-separated list of column names to display.

  • help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

  • local (bool | None) – If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

  • master_timeout (Literal[-1] | ~typing.Literal[0] | str | None) – Period to wait for a connection to the master node.

  • s (Sequence[Literal['ae', 'bc', 'id', 'na', 'ne', 'ni', 'nn', 's', 'sba', 'sc', 'seah', 'st'] | str] | ~typing.Literal['ae', 'bc', 'id', 'na', 'ne', 'ni', 'nn', 's', 'sba', 'sc', 'seah', 'st'] | str | None) – Comma-separated list of column names or column aliases used to sort the response.

  • time (Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | str | None) – The unit used to display time values.

  • v (bool | None) – When set to true will enable verbose output.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any] | TextApiResponse

ml_jobs(*, job_id=None, allow_no_match=None, bytes=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, time=None, v=None)

Gets configuration and usage information about anomaly detection jobs.

https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-anomaly-detectors.html

Parameters:
  • job_id (str | None) – Identifier for the anomaly detection job.

  • allow_no_match (bool | None) – 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.

  • bytes (Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | str | None) – The unit used to display byte values.

  • format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

  • h (Sequence[Literal['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'] | str] | ~typing.Literal['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'] | str | None) – Comma-separated list of column names to display.

  • help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

  • local (bool | None) – If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

  • master_timeout (Literal[-1] | ~typing.Literal[0] | str | None) – Period to wait for a connection to the master node.

  • s (Sequence[Literal['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'] | str] | ~typing.Literal['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'] | str | None) – Comma-separated list of column names or column aliases used to sort the response.

  • time (Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | str | None) – The unit used to display time values.

  • v (bool | None) – When set to true will enable verbose output.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any] | TextApiResponse

ml_trained_models(*, model_id=None, allow_no_match=None, bytes=None, error_trace=None, filter_path=None, format=None, from_=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, size=None, v=None)

Gets configuration and usage information about inference trained models.

https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-trained-model.html

Parameters:
  • model_id (str | None) – A unique identifier for the trained model.

  • allow_no_match (bool | None) – Specifies what to do when the request: contains wildcard expressions and there are no models 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 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.

  • bytes (Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | str | None) – The unit used to display byte values.

  • format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

  • from – Skips the specified number of transforms.

  • h (Sequence[Literal['create_time', 'created_by', 'data_frame_analytics_id', 'description', 'heap_size', 'id', 'ingest.count', 'ingest.current', 'ingest.failed', 'ingest.pipelines', 'ingest.time', 'license', 'operations', 'version'] | str] | ~typing.Literal['create_time', 'created_by', 'data_frame_analytics_id', 'description', 'heap_size', 'id', 'ingest.count', 'ingest.current', 'ingest.failed', 'ingest.pipelines', 'ingest.time', 'license', 'operations', 'version'] | str | None) – A comma-separated list of column names to display.

  • help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

  • local (bool | None) – If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

  • master_timeout (Literal[-1] | ~typing.Literal[0] | str | None) – Period to wait for a connection to the master node.

  • s (Sequence[Literal['create_time', 'created_by', 'data_frame_analytics_id', 'description', 'heap_size', 'id', 'ingest.count', 'ingest.current', 'ingest.failed', 'ingest.pipelines', 'ingest.time', 'license', 'operations', 'version'] | str] | ~typing.Literal['create_time', 'created_by', 'data_frame_analytics_id', 'description', 'heap_size', 'id', 'ingest.count', 'ingest.current', 'ingest.failed', 'ingest.pipelines', 'ingest.time', 'license', 'operations', 'version'] | str | None) – A comma-separated list of column names or aliases used to sort the response.

  • size (int | None) – The maximum number of transforms to display.

  • v (bool | None) – When set to true will enable verbose output.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • from_ (int | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any] | TextApiResponse

nodeattrs(*, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, v=None)

Returns information about custom node attributes.

https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-nodeattrs.html

Parameters:
  • format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

  • h (str | Sequence[str] | None) – List of columns to appear in the response. Supports simple wildcards.

  • help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

  • local (bool | None) – If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

  • master_timeout (Literal[-1] | ~typing.Literal[0] | str | None) – Period to wait for a connection to the master node.

  • s (str | Sequence[str] | None) – List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

  • v (bool | None) – When set to true will enable verbose output.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any] | TextApiResponse

nodes(*, bytes=None, error_trace=None, filter_path=None, format=None, full_id=None, h=None, help=None, human=None, include_unloaded_segments=None, local=None, master_timeout=None, pretty=None, s=None, v=None)

Returns basic statistics about performance of cluster nodes.

https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-nodes.html

Parameters:
  • bytes (Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | str | None) – The unit used to display byte values.

  • format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

  • full_id (bool | str | None) – If true, return the full node ID. If false, return the shortened node ID.

  • h (str | Sequence[str] | None) – List of columns to appear in the response. Supports simple wildcards.

  • help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

  • include_unloaded_segments (bool | None) – If true, the response includes information from segments that are not loaded into memory.

  • local (bool | None) – If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

  • master_timeout (Literal[-1] | ~typing.Literal[0] | str | None) – Period to wait for a connection to the master node.

  • s (str | Sequence[str] | None) – List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

  • v (bool | None) – When set to true will enable verbose output.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any] | TextApiResponse

pending_tasks(*, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, v=None)

Returns a concise representation of the cluster pending tasks.

https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-pending-tasks.html

Parameters:
  • format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

  • h (str | Sequence[str] | None) – List of columns to appear in the response. Supports simple wildcards.

  • help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

  • local (bool | None) – If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

  • master_timeout (Literal[-1] | ~typing.Literal[0] | str | None) – Period to wait for a connection to the master node.

  • s (str | Sequence[str] | None) – List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

  • v (bool | None) – When set to true will enable verbose output.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any] | TextApiResponse

plugins(*, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, v=None)

Returns information about installed plugins across nodes node.

https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-plugins.html

Parameters:
  • format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

  • h (str | Sequence[str] | None) – List of columns to appear in the response. Supports simple wildcards.

  • help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

  • local (bool | None) – If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

  • master_timeout (Literal[-1] | ~typing.Literal[0] | str | None) – Period to wait for a connection to the master node.

  • s (str | Sequence[str] | None) – List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

  • v (bool | None) – When set to true will enable verbose output.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any] | TextApiResponse

recovery(*, index=None, active_only=None, bytes=None, detailed=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, v=None)

Returns information about index shard recoveries, both on-going completed.

https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-recovery.html

Parameters:
  • index (str | Sequence[str] | None) – A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

  • active_only (bool | None) – If true, the response only includes ongoing shard recoveries.

  • bytes (Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | str | None) – The unit used to display byte values.

  • detailed (bool | None) – If true, the response includes detailed information about shard recoveries.

  • format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

  • h (str | Sequence[str] | None) – List of columns to appear in the response. Supports simple wildcards.

  • help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

  • local (bool | None) – If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

  • master_timeout (Literal[-1] | ~typing.Literal[0] | str | None) – Period to wait for a connection to the master node.

  • s (str | Sequence[str] | None) – List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

  • v (bool | None) – When set to true will enable verbose output.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any] | TextApiResponse

repositories(*, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, v=None)

Returns information about snapshot repositories registered in the cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-repositories.html

Parameters:
  • format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

  • h (str | Sequence[str] | None) – List of columns to appear in the response. Supports simple wildcards.

  • help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

  • local (bool | None) – If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

  • master_timeout (Literal[-1] | ~typing.Literal[0] | str | None) – Period to wait for a connection to the master node.

  • s (str | Sequence[str] | None) – List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

  • v (bool | None) – When set to true will enable verbose output.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any] | TextApiResponse

segments(*, index=None, bytes=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, v=None)

Provides low-level information about the segments in the shards of an index.

https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-segments.html

Parameters:
  • index (str | Sequence[str] | None) – A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

  • bytes (Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | str | None) – The unit used to display byte values.

  • format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

  • h (str | Sequence[str] | None) – List of columns to appear in the response. Supports simple wildcards.

  • help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

  • local (bool | None) – If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

  • master_timeout (Literal[-1] | ~typing.Literal[0] | str | None) – Period to wait for a connection to the master node.

  • s (str | Sequence[str] | None) – List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

  • v (bool | None) – When set to true will enable verbose output.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any] | TextApiResponse

shards(*, index=None, bytes=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, v=None)

Provides a detailed view of shard allocation on nodes.

https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-shards.html

Parameters:
  • index (str | Sequence[str] | None) – A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

  • bytes (Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | str | None) – The unit used to display byte values.

  • format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

  • h (str | Sequence[str] | None) – List of columns to appear in the response. Supports simple wildcards.

  • help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

  • local (bool | None) – If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

  • master_timeout (Literal[-1] | ~typing.Literal[0] | str | None) – Period to wait for a connection to the master node.

  • s (str | Sequence[str] | None) – List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

  • v (bool | None) – When set to true will enable verbose output.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any] | TextApiResponse

snapshots(*, repository=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, ignore_unavailable=None, local=None, master_timeout=None, pretty=None, s=None, v=None)

Returns all snapshots in a specific repository.

https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-snapshots.html

Parameters:
  • repository (str | Sequence[str] | None) – A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. _all returns all repositories. If any repository fails during the request, Elasticsearch returns an error.

  • format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

  • h (str | Sequence[str] | None) – List of columns to appear in the response. Supports simple wildcards.

  • help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

  • ignore_unavailable (bool | None) – If true, the response does not include information from unavailable snapshots.

  • local (bool | None) – If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

  • master_timeout (Literal[-1] | ~typing.Literal[0] | str | None) – Period to wait for a connection to the master node.

  • s (str | Sequence[str] | None) – List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

  • v (bool | None) – When set to true will enable verbose output.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any] | TextApiResponse

tasks(*, actions=None, detailed=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, node_id=None, parent_task_id=None, pretty=None, s=None, v=None)

Returns information about the tasks currently executing on one or more nodes in the cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/8.14/tasks.html

Parameters:
  • actions (Sequence[str] | None) – The task action names, which are used to limit the response.

  • detailed (bool | None) – If true, the response includes detailed information about shard recoveries.

  • format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

  • h (str | Sequence[str] | None) – List of columns to appear in the response. Supports simple wildcards.

  • help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

  • local (bool | None) – If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

  • master_timeout (Literal[-1] | ~typing.Literal[0] | str | None) – Period to wait for a connection to the master node.

  • node_id (Sequence[str] | None) – Unique node identifiers, which are used to limit the response.

  • parent_task_id (str | None) – The parent task identifier, which is used to limit the response.

  • s (str | Sequence[str] | None) – List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

  • v (bool | None) – When set to true will enable verbose output.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any] | TextApiResponse

templates(*, name=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, v=None)

Returns information about existing templates.

https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-templates.html

Parameters:
  • name (str | None) – The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned.

  • format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

  • h (str | Sequence[str] | None) – List of columns to appear in the response. Supports simple wildcards.

  • help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

  • local (bool | None) – If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

  • master_timeout (Literal[-1] | ~typing.Literal[0] | str | None) – Period to wait for a connection to the master node.

  • s (str | Sequence[str] | None) – List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

  • v (bool | None) – When set to true will enable verbose output.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any] | TextApiResponse

thread_pool(*, thread_pool_patterns=None, error_trace=None, filter_path=None, format=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, time=None, v=None)

Returns cluster-wide thread pool statistics per node. By default the active, queue and rejected statistics are returned for all thread pools.

https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-thread-pool.html

Parameters:
  • thread_pool_patterns (str | Sequence[str] | None) – A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions.

  • format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

  • h (str | Sequence[str] | None) – List of columns to appear in the response. Supports simple wildcards.

  • help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

  • local (bool | None) – If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

  • master_timeout (Literal[-1] | ~typing.Literal[0] | str | None) – Period to wait for a connection to the master node.

  • s (str | Sequence[str] | None) – List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

  • time (Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | str | None) – The unit used to display time values.

  • v (bool | None) – When set to true will enable verbose output.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any] | TextApiResponse

transforms(*, transform_id=None, allow_no_match=None, error_trace=None, filter_path=None, format=None, from_=None, h=None, help=None, human=None, local=None, master_timeout=None, pretty=None, s=None, size=None, time=None, v=None)

Gets configuration and usage information about transforms.

https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-transforms.html

Parameters:
  • transform_id (str | None) – A transform identifier or a wildcard expression. If you do not specify one of these options, the API returns information for all transforms.

  • allow_no_match (bool | None) – Specifies what to do when the request: contains wildcard expressions and there are no transforms 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, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches. If false, the request returns a 404 status code when there are no matches or only partial matches.

  • format (str | None) – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

  • from – Skips the specified number of transforms.

  • h (Sequence[Literal['changes_last_detection_time', 'checkpoint', 'checkpoint_duration_time_exp_avg', 'checkpoint_progress', 'create_time', 'delete_time', 'description', 'dest_index', 'docs_per_second', 'documents_deleted', 'documents_indexed', 'documents_processed', 'frequency', 'id', 'index_failure', 'index_time', 'index_total', 'indexed_documents_exp_avg', 'last_search_time', 'max_page_search_size', 'pages_processed', 'pipeline', 'processed_documents_exp_avg', 'processing_time', 'reason', 'search_failure', 'search_time', 'search_total', 'source_index', 'state', 'transform_type', 'trigger_count', 'version'] | str] | ~typing.Literal['changes_last_detection_time', 'checkpoint', 'checkpoint_duration_time_exp_avg', 'checkpoint_progress', 'create_time', 'delete_time', 'description', 'dest_index', 'docs_per_second', 'documents_deleted', 'documents_indexed', 'documents_processed', 'frequency', 'id', 'index_failure', 'index_time', 'index_total', 'indexed_documents_exp_avg', 'last_search_time', 'max_page_search_size', 'pages_processed', 'pipeline', 'processed_documents_exp_avg', 'processing_time', 'reason', 'search_failure', 'search_time', 'search_total', 'source_index', 'state', 'transform_type', 'trigger_count', 'version'] | str | None) – Comma-separated list of column names to display.

  • help (bool | None) – When set to true will output available columns. This option can’t be combined with any other query string option.

  • local (bool | None) – If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

  • master_timeout (Literal[-1] | ~typing.Literal[0] | str | None) – Period to wait for a connection to the master node.

  • s (Sequence[Literal['changes_last_detection_time', 'checkpoint', 'checkpoint_duration_time_exp_avg', 'checkpoint_progress', 'create_time', 'delete_time', 'description', 'dest_index', 'docs_per_second', 'documents_deleted', 'documents_indexed', 'documents_processed', 'frequency', 'id', 'index_failure', 'index_time', 'index_total', 'indexed_documents_exp_avg', 'last_search_time', 'max_page_search_size', 'pages_processed', 'pipeline', 'processed_documents_exp_avg', 'processing_time', 'reason', 'search_failure', 'search_time', 'search_total', 'source_index', 'state', 'transform_type', 'trigger_count', 'version'] | str] | ~typing.Literal['changes_last_detection_time', 'checkpoint', 'checkpoint_duration_time_exp_avg', 'checkpoint_progress', 'create_time', 'delete_time', 'description', 'dest_index', 'docs_per_second', 'documents_deleted', 'documents_indexed', 'documents_processed', 'frequency', 'id', 'index_failure', 'index_time', 'index_total', 'indexed_documents_exp_avg', 'last_search_time', 'max_page_search_size', 'pages_processed', 'pipeline', 'processed_documents_exp_avg', 'processing_time', 'reason', 'search_failure', 'search_time', 'search_total', 'source_index', 'state', 'transform_type', 'trigger_count', 'version'] | str | None) – Comma-separated list of column names or column aliases used to sort the response.

  • size (int | None) – The maximum number of transforms to obtain.

  • time (Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | str | None) – The unit used to display time values.

  • v (bool | None) – When set to true will enable verbose output.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • from_ (int | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any] | TextApiResponse