› › ›

获取数据馈送 API

编辑

获取数据馈送 API

编辑

检索数据馈送的配置信息。

请求

编辑

GET _ml/datafeeds/<feed_id>

GET _ml/datafeeds/<feed_id>,<feed_id>

GET _ml/datafeeds/

GET _ml/datafeeds/_all

先决条件

编辑

需要 monitor_ml 集群权限。此权限包含在内置角色 machine_learning_user 中。

描述

编辑

此 API 最多返回 10,000 个数据馈送。

路径参数

编辑

<feed_id>

(可选，字符串) 数据馈送的标识符。它可以是数据馈送标识符或通配符表达式。

您可以通过使用逗号分隔的数据馈送列表或通配符表达式，在单个 API 请求中获取多个数据馈送的信息。您可以通过使用 _all、将 * 指定为数据馈送标识符或省略标识符来获取所有数据馈送的信息。

查询参数

编辑

allow_no_match

(可选，布尔值) 指定在请求时该怎么做

包含通配符表达式，并且没有匹配的数据馈送。
包含 _all 字符串或没有标识符，并且没有匹配项。
包含通配符表达式，并且只有部分匹配项。

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

exclude_generated

(可选，布尔值) 指示在检索时是否应从配置中删除某些字段。这允许配置以可接受的格式进行检索，然后添加到另一个集群。默认为 false。

响应正文

编辑

API 返回一个数据馈送资源数组。有关属性的完整列表，请参阅创建数据馈送 API。

响应代码

编辑

404（缺少资源）: 如果 allow_no_match 为 false，则此代码表示没有匹配请求的资源或请求只有部分匹配项。

示例

编辑

resp = client.ml.get_datafeeds(
    datafeed_id="datafeed-high_sum_total_sales",
)
print(resp)

response = client.ml.get_datafeeds(
  datafeed_id: 'datafeed-high_sum_total_sales'
)
puts response

const response = await client.ml.getDatafeeds({
  datafeed_id: "datafeed-high_sum_total_sales",
});
console.log(response);

GET _ml/datafeeds/datafeed-high_sum_total_sales

API 返回以下结果

{
  "count" : 1,
  "datafeeds" : [
    {
      "datafeed_id" : "datafeed-high_sum_total_sales",
      "job_id" : "high_sum_total_sales",
      "authorization" : {
        "roles" : [
          "superuser"
        ]
      },
      "query_delay" : "93169ms",
      "chunking_config" : {
        "mode" : "auto"
      },
      "indices_options" : {
        "expand_wildcards" : [
          "open"
        ],
        "ignore_unavailable" : false,
        "allow_no_indices" : true,
        "ignore_throttled" : true
      },
      "query" : {
        "bool" : {
          "filter" : [
            {
              "term" : {
                "event.dataset" : "sample_ecommerce"
              }
            }
          ]
        }
      },
      "indices" : [
        "kibana_sample_data_ecommerce"
      ],
      "scroll_size" : 1000,
      "delayed_data_check_config" : {
        "enabled" : true
      }
    }
  ]
}

« 获取类别 API 获取数据馈送统计信息 API »