cat transforms API
editcat transforms API
editReturns configuration and usage information about transforms.
Request
editGET /_cat/transforms/<transform_id>
GET /_cat/transforms/_all
GET /_cat/transforms/*
GET /_cat/transforms
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have
monitor_transform
cluster privileges to use this API. The built-intransform_user
role has these privileges. For more information, see Security privileges and Built-in roles.
Path parameters
edit-
<transform_id>
- (Optional, string) Identifier for the transform. It can be a transform identifier or a wildcard expression. If you do not specify one of these options, the API returns information for all transforms.
Query parameters
edit-
allow_no_match
-
(Optional, Boolean) 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.
The default value is
true
, which returns an emptytransforms
array when there are no matches and the subset of results when there are partial matches.If this parameter is
false
, the request returns a404
status code when there are no matches or only partial matches. -
format
- (Optional, string) Short version of the HTTP accept header. Valid values include JSON, YAML, etc.
-
from
-
(Optional, integer)
Skips the specified number of transforms. The default value is
0
. -
h
-
(Optional, string) Comma-separated list of column names to display.
If you do not specify which columns to include, the API returns the default columns. If you explicitly specify one or more columns, it returns only the specified columns.
Valid columns are:
-
changes_last_detection_time
,cldt
- The timestamp when changes were last detected in the source indices.
-
checkpoint_duration_time_exp_avg
,cdtea
,checkpointTimeExpAvg
- Exponential moving average of the duration of the checkpoint, in milliseconds.
-
create_time
,ct
,createTime
- (Default) The time the transform was created.
-
description
,d
- (Default) The description of the transform.
-
dest_index
,di
,destIndex
- (Default) The destination index for the transform. The mappings of the destination index are deduced based on the source fields when possible. If alternate mappings are required, use the Create index API prior to starting the transform.
-
documents_indexed
,doci
- The number of documents that have been indexed into the destination index for the transform.
-
docs_per_second
,dps
-
(Default)
Specifies a limit on the number of input documents per second. This setting
throttles the transform by adding a wait time between search requests. The
default value is
null
, which disables throttling. -
documents_processed
,docp
- The number of documents that have been processed from the source index of the transform.
-
frequency
,f
-
(Default)
The interval between checks for changes in the source indices when the
transform is running continuously. Also determines the retry interval in the
event of transient failures while the transform is searching or indexing. The
minimum value is
1s
and the maximum is1h
. The default value is1m
. -
id
- (Default) Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.
-
index_failure
,if
- The number of indexing failures.
-
index_time
,itime
- The amount of time spent indexing, in milliseconds.
-
index_total
,it
- The number of indices created.
-
indexed_documents_exp_avg
,idea
- Exponential moving average of the number of new documents that have been indexed.
-
max_page_search_size
,mpsz
-
(Default)
Defines the initial page size to use for the composite aggregation for each
checkpoint. If circuit breaker exceptions occur, the page size is dynamically
adjusted to a lower value. The minimum value is
10
and the maximum is10,000
. The default value is500
. -
pages_processed
,pp
- The number of search or bulk index operations processed. Documents are processed in batches instead of individually.
-
pipeline
,p
- (Default) The unique identifier for a pipeline.
-
processed_documents_exp_avg
,pdea
- Exponential moving average of the number of documents that have been processed.
-
processing_time
,pt
- The amount of time spent processing results, in milliseconds.
-
reason
,r
-
If a transform has a
failed
state, this property provides details about the reason for the failure. -
search_failure
,sf
- The number of search failures.
-
search_time
,stime
- The amount of time spent searching, in milliseconds.
-
search_total
,st
- The number of search operations on the source index for the transform.
-
source_index
,si
,sourceIndex
-
(Default)
The source indices for the transform. It can be a single index, an index
pattern (for example,
"my-index-*"
), an array of indices (for example,["my-index-000001", "my-index-000002"]
), or an array of index patterns (for example,["my-index-*", "my-other-index-*"]
. -
state
,s
-
(Default) The status of the transform, which can be one of the following values:
-
aborting
: The transform is aborting. -
failed
: The transform failed. For more information about the failure, check the reason field. -
indexing
: The transform is actively processing data and creating new documents. -
started
: The transform is running but not actively indexing data. -
stopped
: The transform is stopped. -
stopping
: The transform is stopping.
-
-
transform_type
,tt
-
(Default)
Indicates the type of transform:
batch
orcontinuous
. -
trigger_count
,tc
-
The number of times the transform has been triggered by the scheduler. For
example, the scheduler triggers the transform indexer to check for updates
or ingest new data at an interval specified in the
frequency
property. -
version
,v
- (Default) The version of Elasticsearch that existed on the node when the transform was created.
-
-
help
-
(Optional, Boolean) If
true
, the response includes help information. Defaults tofalse
. -
s
- (Optional, string) Comma-separated list of column names or column aliases used to sort the response.
-
size
-
(Optional, integer)
Specifies the maximum number of transforms to obtain. The default value is
100
. -
time
- (Optional, time units) Unit used to display time values.
-
v
-
(Optional, Boolean) If
true
, the response includes column headings. Defaults tofalse
.
Examples
editGET /_cat/transforms?v&format=json
[ { "id" : "ecommerce_transform", "create_time" : "2020-03-20T20:31:25.077Z", "version" : "7.7.0", "source_index" : "kibana_sample_data_ecommerce", "dest_index" : "kibana_sample_data_ecommerce_transform", "pipeline" : null, "description" : "Maximum priced ecommerce data by customer_id in Asia", "transform_type" : "continuous", "frequency" : "5m", "max_page_search_size" : "500", "state" : "STARTED" } ]