Cat

class elasticsearch_serverless.client.CatClient(client: BaseClient)

Get aliases.

Get the cluster's index aliases, including filter and routing information. This API does not return data stream aliases.

IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-aliases

Parameters:

name – A comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all.
expand_wildcards – The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as open,hidden.
format – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.
h – List of columns to appear in the response. Supports simple wildcards.
help – When set to true will output available columns. This option can’t be combined with any other query string option.
master_timeout – The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicated that the request should never timeout, you can set it to -1.
s – 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 – When set to true will enable verbose output.

Get component templates.

Get information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.

IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get component template API.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-component-templates

Parameters:

name – The name of the component template. It accepts wildcard expressions. If it is omitted, all component templates are returned.
format – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.
h – List of columns to appear in the response. Supports simple wildcards.
help – When set to true will output available columns. This option can’t be combined with any other query string option.
local – 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 – The period to wait for a connection to the master node.
s – 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 – When set to true will enable verbose output.

Get a document count.

Get quick access to a document count for a data stream, an index, or an entire cluster. The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.

IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the count API.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-count

Parameters:

index – A comma-separated list of data streams, indices, and aliases used to limit the request. It supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.
format – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.
h – List of columns to appear in the response. Supports simple wildcards.
help – When set to true will output available columns. This option can’t be combined with any other query string option.
s – 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 – When set to true will enable verbose output.

help() → TextApiResponse

Get CAT help.

Get help for the CAT APIs.

https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cat

Get index information.

Get high-level information about indices in a cluster, including backing indices for data streams.

Use this request to get the following information for each index in a cluster:

shard count
document count
deleted document count
primary store size
total store size of all shards, including shard replicas

These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents. To get an accurate count of Elasticsearch documents, use the cat count or count APIs.

CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use an index endpoint.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-indices

Parameters:

index – 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 – The unit used to display byte values.
expand_wildcards – The type of index that wildcard patterns can match.
format – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.
h – List of columns to appear in the response. Supports simple wildcards.
health – The health status used to limit returned indices. By default, the response includes indices of any health status.
help – When set to true will output available columns. This option can’t be combined with any other query string option.
include_unloaded_segments – If true, the response includes information from segments that are not loaded into memory.
master_timeout – Period to wait for a connection to the master node.
pri – If true, the response only includes information from primary shards.
s – 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 – The unit used to display time values.
v – When set to true will enable verbose output.

ml_data_frame_analytics(*, id: str | None = None, allow_no_match: bool | None = None, bytes: str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None = None, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, format: str | None = None, h: Sequence[str | 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 | 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'] | None = None, help: bool | None = None, human: bool | None = None, pretty: bool | None = None, s: Sequence[str | 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 | 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'] | None = None, time: str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None = None, v: bool | None = None) → ObjectApiResponse[Any] | TextApiResponse

Get data frame analytics jobs.

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.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-data-frame-analytics

Parameters:

id – The ID of the data frame analytics to fetch
allow_no_match – Whether to ignore if a wildcard expression matches no configs. (This includes _all string or when no configs have been specified)
bytes – The unit in which to display byte values
format – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.
h – Comma-separated list of column names to display.
help – When set to true will output available columns. This option can’t be combined with any other query string option.
s – Comma-separated list of column names or column aliases used to sort the response.
time – Unit used to display time values.
v – When set to true will enable verbose output.

Get datafeeds.

Get configuration and usage information about datafeeds. This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled, you must have monitor_ml, monitor, manage_ml, or manage cluster privileges to use this API.

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 datafeed statistics API.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-datafeeds

Parameters:

datafeed_id – A numerical character string that uniquely identifies the datafeed.
allow_no_match – 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 – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.
h – Comma-separated list of column names to display.
help – When set to true will output available columns. This option can’t be combined with any other query string option.
s – Comma-separated list of column names or column aliases used to sort the response.
time – The unit used to display time values.
v – When set to true will enable verbose output.

ml_jobs(*, job_id: str | None = None, allow_no_match: bool | None = None, bytes: str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None = None, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, format: str | None = None, h: Sequence[str | 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 | 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'] | None = None, help: bool | None = None, human: bool | None = None, pretty: bool | None = None, s: Sequence[str | 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 | 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'] | None = None, time: str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None = None, v: bool | None = None) → ObjectApiResponse[Any] | TextApiResponse

Get anomaly detection jobs.

Get configuration and usage information for anomaly detection jobs. This API returns a maximum of 10,000 jobs. If the Elasticsearch security features are enabled, you must have monitor_ml, monitor, manage_ml, or manage cluster privileges to use this API.

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 anomaly detection job statistics API.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-jobs

Parameters:

job_id – Identifier for the anomaly detection job.
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.
bytes – The unit used to display byte values.
format – Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.
h – Comma-separated list of column names to display.
help – When set to true will output available columns. This option can’t be combined with any other query string option.
s – Comma-separated list of column names or column aliases used to sort the response.
time – The unit used to display time values.
v – When set to true will enable verbose output.

ml_trained_models(*, model_id: str | None = None, allow_no_match: bool | None = None, bytes: str | Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb'] | None = None, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, format: str | None = None, from_: int | None = None, h: Sequence[str | 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 | 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'] | None = None, help: bool | None = None, human: bool | None = None, pretty: bool | None = None, s: Sequence[str | 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 | 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'] | None = None, size: int | None = None, time: str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None = None, v: bool | None = None) → ObjectApiResponse[Any] | TextApiResponse

Get trained models.

Get configuration and usage information about inference trained models.

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 trained models statistics API.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-trained-models

Parameters:

model_id – A unique identifier for the trained model.
allow_no_match – 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 – The unit used to display byte values.
format – 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 – A comma-separated list of column names to display.
help – When set to true will output available columns. This option can’t be combined with any other query string option.
s – A comma-separated list of column names or aliases used to sort the response.
size – The maximum number of transforms to display.
time – Unit used to display time values.
v – When set to true will enable verbose output.

transforms(*, transform_id: str | None = None, allow_no_match: bool | None = None, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, format: str | None = None, from_: int | None = None, h: Sequence[str | 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 | 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'] | None = None, help: bool | None = None, human: bool | None = None, pretty: bool | None = None, s: Sequence[str | 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 | 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'] | None = None, size: int | None = None, time: str | Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's'] | None = None, v: bool | None = None) → ObjectApiResponse[Any] | TextApiResponse

Get transform information.

Get configuration and usage information about transforms.

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 transform statistics API.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-transforms

Parameters:

transform_id – 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 – 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 – 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 – Comma-separated list of column names to display.
help – When set to true will output available columns. This option can’t be combined with any other query string option.
s – Comma-separated list of column names or column aliases used to sort the response.
size – The maximum number of transforms to obtain.
time – The unit used to display time values.
v – When set to true will enable verbose output.