› › ›

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
      }
    }
  ]
}

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-datafeed.html