158 lines
4.1 KiB
Plaintext
158 lines
4.1 KiB
Plaintext
[role="xpack"]
|
|
[testenv="basic"]
|
|
[[get-transform]]
|
|
=== Get {transforms} API
|
|
|
|
[subs="attributes"]
|
|
++++
|
|
<titleabbrev>Get {transforms}</titleabbrev>
|
|
++++
|
|
|
|
Retrieves configuration information for {transforms}.
|
|
|
|
beta[]
|
|
|
|
[[get-transform-request]]
|
|
==== {api-request-title}
|
|
|
|
`GET _transform/<transform_id>` +
|
|
|
|
`GET _transform/<transform_id>,<transform_id>` +
|
|
|
|
`GET _transform/` +
|
|
|
|
`GET _transform/_all` +
|
|
|
|
`GET _transform/*`
|
|
|
|
[[get-transform-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* If the {es} {security-features} are enabled, you must have `monitor_transform`
|
|
cluster privileges to use this API. The built-in `transform_user` role has these
|
|
privileges. For more information, see <<security-privileges>> and
|
|
<<built-in-roles>>.
|
|
|
|
[[get-transform-desc]]
|
|
==== {api-description-title}
|
|
|
|
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>`.
|
|
|
|
[[get-transform-path-parms]]
|
|
==== {api-path-parms-title}
|
|
|
|
`<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}.
|
|
|
|
[[get-transform-query-parms]]
|
|
==== {api-query-parms-title}
|
|
|
|
`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 empty `transforms` array when
|
|
there are no matches and the subset of results when there are partial matches.
|
|
If this parameter is `false`, the request returns a `404` 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`.
|
|
|
|
[[get-transform-response]]
|
|
==== {api-response-body-title}
|
|
|
|
`transforms`::
|
|
(array) An array of {transform} resources, which are sorted by the `id` value in
|
|
ascending order. See <<transform-resource>>.
|
|
|
|
[[get-transform-response-codes]]
|
|
==== {api-response-codes-title}
|
|
|
|
`404` (Missing resources)::
|
|
If `allow_no_match` is `false`, this code indicates that there are no
|
|
resources that match the request or only partial matches for the request.
|
|
|
|
[[get-transform-example]]
|
|
==== {api-examples-title}
|
|
|
|
The following example retrieves information about a maximum of ten {transforms}:
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
GET _transform?size=10
|
|
--------------------------------------------------
|
|
// TEST[skip:setup kibana sample data]
|
|
|
|
The following example gets configuration information for the
|
|
`ecommerce_transform` {transform}:
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
GET _transform/ecommerce_transform
|
|
--------------------------------------------------
|
|
// TEST[skip:setup kibana sample data]
|
|
|
|
The API returns the following results:
|
|
|
|
[source,console-result]
|
|
----
|
|
{
|
|
"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"
|
|
}
|
|
]
|
|
}
|
|
|
|
----
|