获取转换 API
编辑获取转换 API编辑
检索转换的配置信息。
请求编辑
GET _transform/<transform_id>
GET _transform/<transform_id>,<transform_id>
GET _transform/
GET _transform/_all
GET _transform/*
先决条件编辑
需要 monitor_transform 集群权限。此权限包含在 transform_user 内置角色中。
描述编辑
您可以使用逗号分隔的标识符列表或通配符表达式，在一个 API 请求中获取多个转换的信息。您可以使用 _all、指定 * 作为 <transform_id> 或省略 <transform_id> 来获取所有转换的信息。
路径参数编辑
-
<transform_id> - (可选，字符串) 转换的标识符。它可以是转换标识符或通配符表达式。如果您没有指定这些选项之一，API 将返回所有转换的信息。
查询参数编辑
-
allow_no_match -
(可选，布尔值) 指定当请求
- 包含通配符表达式，并且没有匹配的转换。
- 包含
_all字符串或没有标识符，并且没有匹配项。 - 包含通配符表达式，并且只有部分匹配。
默认值为
true，当没有匹配项时返回一个空的transforms数组，当有部分匹配项时返回结果子集。如果此参数为
false，当没有匹配项或只有部分匹配项时，请求将返回404状态代码。 -
exclude_generated - (可选，布尔值) 排除在创建转换时自动添加的字段。这允许配置处于可接受的格式，以便检索并添加到另一个集群。默认值为 false。
-
from - (可选，整数) 跳过指定数量的转换。默认值为
0。 -
size - (可选，整数) 指定要获取的最大转换数量。默认值为
100。
响应主体编辑
API 返回一个转换资源数组，这些资源按 id 值升序排序。有关属性的完整列表，请参见 创建转换 API。
-
create_time - (字符串) 转换创建的时间。例如，
1576094542936。此属性仅供参考；您无法更改其值。 -
version - (字符串) 创建训练模型时的转换配置版本号。
从 Elasticsearch 8.10.0 开始，使用新的版本号来跟踪转换插件中的配置和状态更改。这个新的版本号与产品版本无关，并将独立递增。 version 值表示新的版本号。
响应代码编辑
-
404(缺少资源) - 如果
allow_no_match为false，则此代码表示没有与请求匹配的资源，或者请求只有部分匹配。
示例编辑
以下示例检索最多十个转换的信息
response = client.transform.get_transform( size: 10 ) puts response
GET _transform?size=10
以下示例获取 ecommerce_transform1 转换的配置信息
response = client.transform.get_transform( transform_id: 'ecommerce_transform1' ) puts response
GET _transform/ecommerce_transform1
API 返回以下结果
{
"count" : 1,
"transforms" : [
{
"id" : "ecommerce_transform1",
"authorization" : {
"roles" : [
"superuser"
]
},
"version" : "8.4.0",
"create_time" : 1656023416565,
"source" : {
"index" : [
"kibana_sample_data_ecommerce"
],
"query" : {
"term" : {
"geoip.continent_name" : {
"value" : "Asia"
}
}
}
},
"dest" : {
"index" : "kibana_sample_data_ecommerce_transform1",
"pipeline" : "add_timestamp_pipeline"
},
"frequency" : "5m",
"sync" : {
"time" : {
"field" : "order_date",
"delay" : "60s"
}
},
"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" : { },
"retention_policy" : {
"time" : {
"field" : "order_date",
"max_age" : "30d"
}
}
}
]
}