Get transforms Added in 7.7.0
Returns 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.
Path parameters
-
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
-
allow_no_match 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. Iftrue
, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches. Iffalse
, the request returns a 404 status code when there are no matches or only partial matches. -
from number
Skips the specified number of transforms.
-
h string | array[string]
Comma-separated list of column names to display.
-
s string | array[string]
Comma-separated list of column names or column aliases used to sort the response.
-
time string
The unit used to display time values.
Values are
nanos
,micros
,ms
,s
,m
,h
, ord
. -
size number
The maximum number of transforms to obtain.
curl \
-X GET http://api.example.com/_cat/transforms/{transform_id}
[
{
"id": "string",
"state": "string",
"checkpoint": "string",
"documents_processed": "string",
"checkpoint_progress": "string",
"last_search_time": "string",
"changes_last_detection_time": "string",
"create_time": "string",
"version": "string",
"source_index": "string",
"dest_index": "string",
"pipeline": "string",
"description": "string",
"transform_type": "string",
"frequency": "string",
"max_page_search_size": "string",
"docs_per_second": "string",
"reason": "string",
"search_total": "string",
"search_failure": "string",
"search_time": "string",
"index_total": "string",
"index_failure": "string",
"index_time": "string",
"documents_indexed": "string",
"delete_time": "string",
"documents_deleted": "string",
"trigger_count": "string",
"pages_processed": "string",
"processing_time": "string",
"checkpoint_duration_time_exp_avg": "string",
"indexed_documents_exp_avg": "string",
"processed_documents_exp_avg": "string"
}
]