› › ›

cat 数据帧分析 API

编辑

cat 数据帧分析 API编辑

cat API 仅用于使用命令行或 Kibana 控制台的人类使用。它们不适用于应用程序。对于应用程序使用，请使用获取数据帧分析作业统计信息 API。

返回有关数据帧分析作业的配置和使用信息。

请求编辑

GET /_cat/ml/data_frame/analytics/<data_frame_analytics_id>

GET /_cat/ml/data_frame/analytics

先决条件编辑

如果启用了 Elasticsearch 安全功能，则您必须具有以下权限

集群：monitor_ml

有关更多信息，请参阅安全权限和机器学习安全权限。

路径参数编辑

<data_frame_analytics_id>: (可选，字符串) 数据帧分析作业的标识符。如果您未指定此选项，则 API 将返回前一百个数据帧分析作业的信息。

查询参数编辑

format

(可选，字符串) HTTP 接受标头的简短版本。有效值包括 JSON、YAML 等。

h

(可选，字符串) 要显示的列名称的逗号分隔列表。

如果您未指定要包含的列，则 API 将返回默认列。如果您明确指定一个或多个列，它将仅返回指定的列。

有效列为

assignment_explanation, ae: 包含与节点选择相关的消息。
create_time, ct, createTime: (默认) 创建数据帧分析作业的时间。
description, d: 作业的描述。
dest_index, di, destIndex: 目标索引的名称。
failure_reason, fr, failureReason: 包含有关数据帧分析作业失败原因的消息。
id: (默认) 数据帧分析作业的标识符。
model_memory_limit, mml, modelMemoryLimit: 数据帧分析作业允许使用的最大内存资源量（近似值）。
node.address, na, nodeAddress: 分配数据帧分析作业的节点的网络地址。
node.ephemeral_id, ne, nodeEphemeralId: 分配数据帧分析作业的节点的短暂 ID。
node.id, ni, nodeId: 分配数据帧分析作业的节点的唯一标识符。
node.name, nn, nodeName: 分配数据帧分析作业的节点的名称。
progress, p: 数据帧分析作业按阶段的进度报告。
source_index, si, sourceIndex: 源索引的名称。
state, s: (默认) 数据帧分析作业的当前状态。
type, t: (默认) 数据帧分析作业执行的分析类型。
version, v: 创建数据帧分析作业的 Elasticsearch 版本号。

help

(可选，布尔值) 如果为 true，则响应将包含帮助信息。默认为 false。

s

(可选，字符串) 用于对响应进行排序的列名称或列别名的逗号分隔列表。

time

(可选，时间单位) 用于显示时间值的单位。

v

(可选，布尔值) 如果为 true，则响应将包含列标题。默认为 false。

示例编辑

response = client.cat.ml_data_frame_analytics(
  v: true
)
puts response

GET _cat/ml/data_frame/analytics?v=true

id               create_time              type             state
classifier_job_1 2020-02-12T11:49:09.594Z classification stopped
classifier_job_2 2020-02-12T11:49:14.479Z classification stopped
classifier_job_3 2020-02-12T11:49:16.928Z classification stopped
classifier_job_4 2020-02-12T11:49:19.127Z classification stopped
classifier_job_5 2020-02-12T11:49:21.349Z classification stopped

« cat count API cat datafeeds API »