Get transforms APIedit
Retrieves configuration information for transforms.
This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
Requestedit
GET _transform/<transform_id>
GET _transform/<transform_id>,<transform_id>
GET _transform/
GET _transform/_all
GET _transform/*
Prerequisitesedit
-
If the Elasticsearch security features are enabled, you must have
monitor_transformcluster privileges to use this API. The built-intransform_userrole has these privileges. For more information, see Security privileges and Built-in roles.
Descriptionedit
You 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 parametersedit
-
<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 parametersedit
-
allow_no_match -
(Optional, boolean) Specifies what to do when the request:
- Contains wildcard expressions and there are no transforms that match.
-
Contains the
_allstring 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 emptytransformsarray when there are no matches and the subset of results when there are partial matches.If this parameter is
false, the request returns a404status 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 bodyedit
The 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 codesedit
-
404(Missing resources) -
If
allow_no_matchisfalse, this code indicates that there are no resources that match the request or only partial matches for the request.
Examplesedit
The 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",
"version" : "7.5.0",
"create_time" : 1576094542936
}
]
}