› › ›

API получения потока данных

Получает информацию об одном или нескольких потоках данных. Смотрите Получение информации о потоке данных.

resp = client.indices.get_data_stream(
    name="my-data-stream",
)
print(resp)

response = client.indices.get_data_stream(
  name: 'my-data-stream'
)
puts response

const response = await client.indices.getDataStream({
  name: "my-data-stream",
});
console.log(response);

GET /_data_stream/my-data-stream

Запрос

GET /_data_stream/<data-stream>

Предварительные условия

Если функции безопасности Elasticsearch включены, у вас должны быть view_index_metadata или manage права доступа к индексу для потока данных.

Параметры пути

<data-stream>: (Необязательно, строка) Список имён потоков данных, разделенных запятыми, для ограничения запроса. Поддерживаются символы подстановки (*). Если опущено, будут возвращены все потоки данных.

Параметры запроса

expand_wildcards

(Необязательно, строка) Тип потока данных, с которым могут совпадать шаблоны подстановки. Поддерживаются значения, разделенные запятыми, такие как open,hidden. Допустимые значения:

all, hidden: Соответствие любому потоку данных, включая скрытые.
open, closed: Соответствие любому нескрытому потоку данных. Потоки данных не могут быть закрыты.
none: Шаблоны подстановки не принимаются.

По умолчанию open.

include_defaults

(Необязательно, логическое значение) Функциональность в [превью] Эта функция находится на стадии технического превью и может быть изменена или удалена в будущих релизах. Elastic будет работать над устранением любых проблем, но функции на стадии технического превью не подпадают под SLA поддержки официальных функций GA. . Если true, вернуть все значения по умолчанию в ответе. По умолчанию false.

verbose

(Необязательно, логическое значение). Если true, возвращает maximum_timestamp, соответствующее полю @timestamp для документов в потоке данных. По умолчанию false.

Тело ответа

data_streams

(массив объектов) Содержит информацию о полученных потоках данных.

Свойства объектов в data_streams

name

(строка) Название потока данных.

timestamp_field

(объект) Содержит информацию о поле @timestamp потока данных.

Свойства timestamp_field

name: (строка) Имя поля отметки времени потока данных, которое должно быть @timestamp. Поле @timestamp должно быть включено в каждый документ, индексированный в поток данных.

indices

(массив объектов) Массив объектов, содержащих информацию об индексах, поддерживающих поток данных.

Последний элемент в этом массиве содержит информацию о текущем индексе записи потока.

Свойства объектов indices

index_name: (строка) Название поддерживающего индекса. Для соглашений об именовании см. Создание.
index_uuid: (строка) Унифицированный идентификатор (UUID) для индекса.
prefer_ilm: (булево) Функциональность в [превью] Эта функциональность находится на стадии технического превью и может быть изменена или удалена в будущих выпусках. Elastic будет работать над устранением любых проблем, но функции на стадии технического превью не подпадают под SLA поддержки официальных функций GA. . Указывает, настроен ли этот индекс на приоритет управления жизненным циклом индекса, когда как управление жизненным циклом индекса, так и жизненный цикл потока данных настроены на управление этим индексом.
managed_by: (строка) Функциональность в [превью] Эта функциональность находится на стадии технического превью и может быть изменена или удалена в будущих выпусках. Elastic будет работать над устранением любых проблем, но функции на стадии технического превью не подпадают под SLA поддержки официальных функций GA. . Указывает систему, управляющую этим индексом.

generation

(целое число) Текущая генерация потока данных. Это число действует как накопительный счет переключений потока, начиная с 1.

_meta

(объект) Пользовательские метаданные для потока, скопированные из объекта _meta соответствующей шаблона индекса потока. Если пусто, этот параметр в ответе пропускается.

status

(строка) Статус работоспособности потока данных.

Этот статус работоспособности основан на состоянии первичных и реплицированных фрагментов индексов, поддерживающих поток.

Значения для status

GREEN: Все фрагменты назначены.
YELLOW: Все первичные фрагменты назначены, но один или несколько реплицированных фрагментов не назначены.
RED: Один или несколько первичных фрагментов не назначены, поэтому некоторые данные недоступны.

template

(строка) Название шаблона индекса, используемого для создания поддерживающих индексов потока данных.

Шаблон индекса должен соответствовать имени потока данных. См. создание шаблона индекса.

ilm_policy

(строка) Название текущей политики жизненного цикла ILM в соответствующем шаблоне индекса потока. Эта политика жизненного цикла устанавливается в настройке index.lifecycle.name.

Если шаблон не включает политику жизненного цикла, это свойство не включается в ответ.

Поддерживающим индексам потока данных могут быть назначены разные политики жизненного цикла. Чтобы получить политику жизненного цикла для отдельных поддерживающих индексов, используйте API получения настроек индекса.

next_generation_managed_by

(строка) Функциональность в [превью] Эта функциональность находится на стадии технического превью и может быть изменена или удалена в будущих выпусках. Elastic будет работать над устранением любых проблем, но функции на стадии технического превью не подпадают под SLA поддержки официальных функций GA. . Указывает систему, которая будет управлять индексом следующей генерации (т. е. следующим индексом записи потока данных).

prefer_ilm

(булево) Функциональность в [превью] Эта функциональность находится на стадии технического превью и может быть изменена или удалена в будущих выпусках. Elastic будет работать над устранением любых проблем, но функции на стадии технического превью не подпадают под SLA поддержки официальных функций GA. . Указывает, настроен ли шаблон индекса, используемый для создания поддерживающих индексов потока данных, на приоритет управления жизненным циклом индекса, когда как управление жизненным циклом индекса, так и жизненный цикл потока данных настроены на управление этим индексом.

hidden

(Булево) Если true, поток данных скрыт.

system

(Булево) Если true, поток данных создан и управляется компонентом Elastic Stack и не может быть изменен через обычное взаимодействие пользователя.

allow_custom_routing

(Булево) Если true, поток данных позволяет настраивать маршрутизацию при записи запроса.

replicated

(Булево) Если true, поток данных создан и управляется кросс-кластерной репликацией, и локальный кластер не может записывать в этот поток данных или изменять его отображения.

lifecycle

(объект) Функциональность в [превью] Эта функциональность находится на стадии технического превью и может быть изменена или удалена в будущих выпусках. Elastic будет работать над устранением любых проблем, но функции на стадии технического превью не подпадают под SLA поддержки официальных функций GA. . Содержит конфигурацию для управления жизненным циклом потока данных.

Свойства lifecycle

data_retention: (строка) Если определено, каждый документ, добавленный в этот поток данных, будет храниться как минимум в течение этого периода. Любое время после этого периода документ может быть удален. Если пусто, каждый документ в этом потоке данных будет храниться неопределенно долго.
rollover: (объект) Условия, которые приведут к переключению поддерживающего индекса, как настроено с помощью настройки кластера cluster.lifecycle.default.rollover. Это свойство является реализационной деталью, и оно будет получено только при установке параметра запроса include_defaults в значение true. Содержание этого поля может быть изменено.

rollover_on_write

(Булево) Если true, следующая запись в этот поток данных сначала вызовет переключение, а затем документ будет индексирован в новый поддерживающий индекс. Если переключение завершится неудачей, запрос индексирования также завершится неудачей.

Примеры

resp = client.indices.get_data_stream(
    name="my-data-stream*",
)
print(resp)

response = client.indices.get_data_stream(
  name: 'my-data-stream*'
)
puts response

const response = await client.indices.getDataStream({
  name: "my-data-stream*",
});
console.log(response);

GET _data_stream/my-data-stream*

API возвращает следующий ответ:

{
  "data_streams": [
    {
      "name": "my-data-stream",
      "timestamp_field": {
        "name": "@timestamp"
      },
      "indices": [
        {
          "index_name": ".ds-my-data-stream-2099.03.07-000001",
          "index_uuid": "xCEhwsp8Tey0-FLNFYVwSg",
          "prefer_ilm": true,
          "ilm_policy": "my-lifecycle-policy",
          "managed_by": "Index Lifecycle Management"
        },
        {
          "index_name": ".ds-my-data-stream-2099.03.08-000002",
          "index_uuid": "PA_JquKGSiKcAKBA8DJ5gw",
          "prefer_ilm": true,
          "ilm_policy": "my-lifecycle-policy",
          "managed_by": "Index Lifecycle Management"
        }
      ],
      "generation": 2,
      "_meta": {
        "my-meta-field": "foo"
      },
      "status": "GREEN",
      "next_generation_managed_by": "Index Lifecycle Management",
      "prefer_ilm": true,
      "template": "my-index-template",
      "ilm_policy": "my-lifecycle-policy",
      "hidden": false,
      "system": false,
      "allow_custom_routing": false,
      "replicated": false,
      "rollover_on_write": false
    },
    {
      "name": "my-data-stream-two",
      "timestamp_field": {
        "name": "@timestamp"
      },
      "indices": [
        {
          "index_name": ".ds-my-data-stream-two-2099.03.08-000001",
          "index_uuid": "3liBu2SYS5axasRt6fUIpA",
          "prefer_ilm": true,
          "ilm_policy": "my-lifecycle-policy",
          "managed_by": "Index Lifecycle Management"
        }
      ],
      "generation": 1,
      "_meta": {
        "my-meta-field": "foo"
      },
      "status": "YELLOW",
      "next_generation_managed_by": "Index Lifecycle Management",
      "prefer_ilm": true,
      "template": "my-index-template",
      "ilm_policy": "my-lifecycle-policy",
      "hidden": false,
      "system": false,
      "allow_custom_routing": false,
      "replicated": false,
      "rollover_on_write": false
    }
  ]
}

© 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/indices-get-data-stream.html