mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-05 20:48:22 +00:00
4063701f5e
Configurations are stored in the .data-frame-internal-1 index, but users should not add configurations directly to the index as additional information to enable access control is added. This adds a warning against allowing access to the internal index.
116 lines
2.4 KiB
Plaintext
116 lines
2.4 KiB
Plaintext
[role="xpack"]
|
|
[testenv="basic"]
|
|
[[get-data-frame-transform]]
|
|
=== Get {dataframe-transforms} API
|
|
|
|
[subs="attributes"]
|
|
++++
|
|
<titleabbrev>Get {dataframe-transforms}</titleabbrev>
|
|
++++
|
|
|
|
Retrieves configuration information for {dataframe-transforms}.
|
|
|
|
|
|
==== Request
|
|
|
|
`GET _data_frame/transforms/<data_frame_transform_id>` +
|
|
|
|
`GET _data_frame/transforms/<data_frame_transform_id>,<data_frame_transform_id>` +
|
|
|
|
`GET _data_frame/transforms/` +
|
|
|
|
`GET _data_frame/transforms/_all` +
|
|
|
|
`GET _data_frame/transforms/*`
|
|
|
|
//===== Description
|
|
|
|
==== Path Parameters
|
|
|
|
`data_frame_transform_id`::
|
|
(string) Identifier for the {dataframe-transform}. It can be a
|
|
{dataframe-transform} identifier or a wildcard expression. If you do not
|
|
specify one of these options, the API returns information for all
|
|
{dataframe-transforms}.
|
|
|
|
////
|
|
==== Request Body
|
|
|
|
`page`::
|
|
`from`:::
|
|
(integer) Skips the specified number of {dataframe-transforms}. The
|
|
default value is `0`.
|
|
|
|
`size`:::
|
|
(integer) Specifies the maximum number of {dataframe-transforms} to obtain.
|
|
The default value is `100`.
|
|
////
|
|
|
|
==== Results
|
|
|
|
The API returns the following information:
|
|
|
|
`transforms`::
|
|
(array) An array of transform resources.
|
|
|
|
//==== Authorization
|
|
|
|
==== Examples
|
|
|
|
The following example gets configuration information for the
|
|
`ecommerce_transform` {dataframe-transform}:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET _data_frame/transforms/ecommerce_transform
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[skip:setup kibana sample data]
|
|
|
|
The API returns the following results:
|
|
[source,js]
|
|
----
|
|
{
|
|
"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"
|
|
},
|
|
"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"
|
|
}
|
|
]
|
|
}
|
|
|
|
----
|
|
// TESTRESPONSE
|