cat transforms API
编辑cat transforms API
编辑cat APIs 仅供人类通过命令行或 Kibana 控制台使用。它们不适用于应用程序使用。对于应用程序使用，请使用 get transforms API。
返回有关 transforms 的配置和使用信息。
请求
编辑GET /_cat/transforms/<transform_id>
GET /_cat/transforms/_all
GET /_cat/transforms/*
GET /_cat/transforms
前提条件
编辑路径参数
编辑-
<transform_id> - （可选，字符串）transform 的标识符。它可以是 transform 标识符或通配符表达式。如果您未指定其中一个选项，则 API 返回所有 transform 的信息。
查询参数
编辑-
allow_no_match -
（可选，布尔值）指定当请求发生以下情况时该如何处理：
- 包含通配符表达式且没有匹配的 transform。
- 包含
_all字符串或没有标识符且没有匹配项。 - 包含通配符表达式且只有部分匹配项。
默认值为
true，当没有匹配项时返回一个空的transforms数组，当有部分匹配项时返回结果的子集。如果此参数为
false，则当没有匹配项或只有部分匹配项时，请求返回404状态代码。 -
format - （可选，字符串）HTTP accept 标头的简短版本。有效值包括 JSON、YAML 等。
-
from - （可选，整数）跳过指定数量的 transform。默认值为
0。 -
h -
（可选，字符串）要显示的列名称的逗号分隔列表。
如果您未指定要包含的列，则 API 返回默认列。如果您显式指定一个或多个列，则仅返回指定的列。
有效列为
-
changes_last_detection_time,cldt - （默认）上次在源索引中检测到更改的时间戳。
-
checkpoint,cp - （默认）检查点的序列号。
-
checkpoint_duration_time_exp_avg,cdtea,checkpointTimeExpAvg - 检查点持续时间的指数移动平均值，以毫秒为单位。
-
checkpoint_progress,c,checkpointProgress - （默认）当前正在进行的下一个检查点的进度。
-
create_time,ct,createTime - 创建 transform 的时间。
-
delete_time,dtime - 删除所花费的时间，以毫秒为单位。
-
description,d - transform 的描述。
-
dest_index,di,destIndex - transform 的目标索引。
-
对于 pivot transform，目标索引的映射会尽可能根据源字段推导得出。如果需要其他映射，请在启动 transform 之前使用 创建索引 API。
对于 latest transform，永远不会推导映射。如果不需要目标索引的动态映射，请在启动 transform 之前使用 创建索引 API。
-
documents_deleted,docd - 由于此 transform 的保留策略，已从目标索引中删除的文档数。
-
documents_indexed,doci - 已为 transform 索引到目标索引中的文档数。
-
docs_per_second,dps - 指定每秒输入文档数的限制。此设置通过在搜索请求之间添加等待时间来限制 transform。默认值为
null，这将禁用限制。 -
documents_processed,docp - （默认）已从 transform 的源索引处理的文档数。
-
frequency,f - 当 transform 连续运行时，检查源索引中更改的间隔。最小值为
1s，最大值为1h。默认值为1m。 -
id - （默认）transform 的标识符。
-
index_failure,if - 索引失败的次数。
-
index_time,itime - 索引所花费的时间，以毫秒为单位。
-
index_total,it - 索引操作的数量。
-
indexed_documents_exp_avg,idea - 已索引的新文档数的指数移动平均值。
-
last_search_time,lst,lastSearchTime - （默认）源索引中上次搜索的时间戳。仅当 transform 正在运行时才显示此字段。
-
max_page_search_size,mpsz - 定义用于每个检查点的复合聚合的初始页面大小。如果发生断路器异常，则页面大小会动态调整为较低的值。最小值为
10，最大值为65,536。默认值为500。 -
pages_processed,pp - 已处理的搜索或批量索引操作的数量。文档按批处理而不是单独处理。
-
pipeline,p - ingest pipeline 的唯一标识符。
-
processed_documents_exp_avg,pdea - 已处理的文档数的指数移动平均值。
-
processing_time,pt - 处理结果所花费的时间，以毫秒为单位。
-
reason,r - 如果 transform 具有
failed状态，则此属性提供有关失败原因的详细信息。 -
search_failure,sf - 搜索失败的次数。
-
search_time,stime - 搜索所花费的时间，以毫秒为单位。
-
search_total,st - transform 源索引上的搜索操作数。
-
source_index,si,sourceIndex -
（默认）transform 的源索引。它可以是单个索引、索引模式（例如，
"my-index-*"）、索引数组（例如，["my-index-000001", "my-index-000002"]）或索引模式数组（例如，["my-index-*", "my-other-index-*"]。对于远程索引，请使用语法"remote_name:index_name"。如果任何索引位于远程集群中，则主节点和至少一个 transform 节点必须具有
remote_cluster_client节点角色。 -
state,s -
（默认）transform 的状态，可以是以下值之一：
-
aborting：transform 正在中止。 -
failed：transform 失败。有关失败的更多信息，请检查 reason 字段。 -
indexing：transform 正在积极处理数据并创建新文档。 -
started：transform 正在运行，但未积极索引数据。 -
stopped：transform 已停止。 -
stopping：transform 正在停止。
-
-
transform_type,tt - 指示 transform 的类型：
batch或continuous。 -
trigger_count,tc - 调度程序触发 transform 的次数。例如，调度程序会以
frequency属性中指定的间隔触发 transform 索引器以检查更新或提取新数据。 -
version,v -
创建 transform 时节点上存在的 Elasticsearch 版本。
-
help - （可选，布尔值）如果为
true，则响应包含帮助信息。默认为false。 -
s - （可选，字符串）用于对响应进行排序的列名称或列别名的逗号分隔列表。
-
size - （可选，整数）指定要获取的最大 transform 数。默认值为
100。 -
time - （可选，时间单位）用于显示时间值的单位。
-
v - （可选，布尔值）如果为
true，则响应包含列标题。默认为false。
-
示例
编辑resp = client.cat.transforms(
v=True,
format="json",
)
print(resp)
response = client.cat.transforms( v: true, format: 'json' ) puts response
const response = await client.cat.transforms({
v: "true",
format: "json",
});
console.log(response);
GET /_cat/transforms?v=true&format=json
[
{
"id" : "ecommerce_transform",
"state" : "started",
"checkpoint" : "1",
"documents_processed" : "705",
"checkpoint_progress" : "100.00",
"changes_last_detection_time" : null
}
]