cat datafeeds API

编辑

cat API 仅供使用命令行或 Kibana 控制台的人员使用。它们**不**适用于应用程序。对于应用程序使用,请使用获取数据馈送统计信息 API

返回有关数据馈送的配置和使用信息。

请求

编辑

GET /_cat/ml/datafeeds/<feed_id>

GET /_cat/ml/datafeeds

先决条件

编辑
  • 如果启用了 Elasticsearch 安全功能,则必须拥有monitor_mlmonitormanage_mlmanage集群权限才能使用此 API。请参阅安全权限机器学习安全权限

描述

编辑

数据馈送从 Elasticsearch 检索数据,供异常检测作业进行分析。有关更多信息,请参阅数据馈送

此 API 最多返回 10,000 个作业。

路径参数

编辑
<feed_id>
(可选,字符串) 一个唯一标识数据馈送的数字字符字符串。此标识符可以包含小写字母数字字符 (a-z 和 0-9)、连字符和下划线。它必须以字母数字字符开头和结尾。

查询参数

编辑
allow_no_match

(可选,布尔值) 指定在请求

  • 包含通配符表达式且没有匹配的数据馈送时该怎么做。
  • 包含_all字符串或没有标识符且没有匹配项。
  • 包含通配符表达式且只有部分匹配。

默认值为true,当没有匹配项时返回空datafeeds数组,当有部分匹配项时返回结果子集。如果此参数为false,则当没有匹配项或只有部分匹配项时,请求返回404状态代码。

format
(可选,字符串)HTTP accept 标头的简短版本。有效值包括 JSON、YAML 等。
h

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

如果不指定要包含哪些列,则 API 将返回默认列。如果显式指定一个或多个列,则只返回指定的列。

有效列为

assignment_explanationae
仅对于已启动的数据馈送,包含与节点选择相关的消息。
buckets.countbcbucketsCount
(默认) 已处理的桶数。
id
(默认) 一个唯一标识数据馈送的数字字符字符串。此标识符可以包含小写字母数字字符 (a-z 和 0-9)、连字符和下划线。它必须以字母数字字符开头和结尾。
node.addressnanodeAddress

节点的网络地址。

仅对于已启动的数据馈送,此信息与启动数据馈送的节点有关。

node.ephemeral_idnenodeEphemeralId

节点的短暂 ID。

仅对于已启动的数据馈送,此信息与启动数据馈送的节点有关。

node.idninodeId

节点的唯一标识符。

仅对于已启动的数据馈送,此信息与启动数据馈送的节点有关。

node.namennnodeName

节点名称。

仅对于已启动的数据馈送,此信息与启动数据馈送的节点有关。

search.bucket_avgsbasearchBucketAvg
每个桶的平均搜索时间(毫秒)。
search.countscsearchCount
(默认) 数据馈送运行的搜索次数。
search.exp_avg_hourseahsearchExpAvgHour
每小时的指数平均搜索时间(毫秒)。
search.timestsearchTime
数据馈送用于搜索的总时间(毫秒)。
states

(默认) 数据馈送的状态,可以是以下值之一

  • starting:已请求数据馈送启动,但尚未启动。
  • started:数据馈送正在积极接收数据。
  • stopping:已请求数据馈送优雅地停止,并且正在完成其最终操作。
  • stopped:数据馈送已停止,在重新启动之前不会接收数据。
help
(可选,布尔值) 如果为true,则响应包含帮助信息。默认为false
s
(可选,字符串) 用于对响应进行排序的列名或列别名的逗号分隔列表。
time
(可选,时间单位) 用于显示时间值的单位。
v
(可选,布尔值) 如果为true,则响应包含列标题。默认为false

示例

编辑
resp = client.cat.ml_datafeeds(
    v=True,
)
print(resp)
response = client.cat.ml_datafeeds(
  v: true
)
puts response
const response = await client.cat.mlDatafeeds({
  v: "true",
});
console.log(response);
GET _cat/ml/datafeeds?v=true
id                              state buckets.count search.count
datafeed-high_sum_total_sales stopped 743          7
datafeed-low_request_rate     stopped 1457         3
datafeed-response_code_rates  stopped 1460         18
datafeed-url_scanning         stopped 1460         18