Get transforms API
editGet transforms API
editRetrieves configuration information for transforms.
Request
editGET _transform/<transform_id>
GET _transform/<transform_id>,<transform_id>
GET _transform/
GET _transform/_all
GET _transform/*
Prerequisites
editIf the Elasticsearch security features are enabled, you must have the following privileges:
-
monitor_transform
The built-in transform_user
role has this privilege.
For more information, see Security privileges and Built-in roles.
Description
editYou can get information for multiple transforms in a single API
request by using a comma-separated list of identifiers or a wildcard expression.
You can get information for all transforms by using _all
, by
specifying *
as the <transform_id>
, or by omitting the <transform_id>
.
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. -
from
-
(Optional, integer)
Skips the specified number of transforms. The default value is
0
. -
size
-
(Optional, integer)
Specifies the maximum number of transforms to obtain. The default value is
100
.
Response body
editThe API returns an array of transform resources, which are sorted by the id
value in ascending order. For the full list of properties, see
Create transform API.
-
create_time
-
(string) The time the transform was created. For example,
1576094542936
. This property is informational; you cannot change its value. -
version
- (string) The version of Elasticsearch that existed on the node when the transform was created.
Response codes
edit-
404
(Missing resources) -
If
allow_no_match
isfalse
, this code indicates that there are no resources that match the request or only partial matches for the request.
Examples
editThe following example retrieves information about a maximum of ten transforms:
GET _transform?size=10
The following example gets configuration information for the
ecommerce_transform
transform:
GET _transform/ecommerce_transform
The API returns the following results:
{ "count" : 1, "transforms" : [ { "id" : "ecommerce_transform", "source" : { "index" : [ "kibana_sample_data_ecommerce" ], "query" : { "term" : { "geoip.continent_name" : { "value" : "Asia" } } } }, "dest" : { "index" : "kibana_sample_data_ecommerce_transform" }, "frequency": "1m", "pivot" : { "group_by" : { "customer_id" : { "terms" : { "field" : "customer_id" } } }, "aggregations" : { "max_price" : { "max" : { "field" : "taxful_total_price" } } } }, "description" : "Maximum priced ecommerce data by customer_id in Asia", "settings" : { }, "version" : "7.5.0", "create_time" : 1576094542936 } ] }