› › ›

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

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

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.

Тело ответа

data_streams

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

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

name

(строка) Имя потока данных.

timestamp_field

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

Свойства timestamp_field

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

indices

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

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

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

index_name: (строка) Имя индекса. Для соглашений об именах см. Генерацию.
index_uuid: (строка) Универсальный уникальный идентификатор (UUID) индекса.

generation

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

_meta

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

status

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

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

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

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

template

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

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

ilm_policy

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

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

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

hidden

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

system

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

replicated

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

Примеры

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"
        },
        {
          "index_name": ".ds-my-data-stream-2099.03.08-000002",
          "index_uuid": "PA_JquKGSiKcAKBA8DJ5gw"
        }
      ],
      "generation": 2,
      "_meta": {
        "my-meta-field": "foo"
      },
      "status": "GREEN",
      "template": "my-index-template",
      "ilm_policy": "my-lifecycle-policy",
      "hidden": false,
      "system": false,
      "replicated": 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"
        }
      ],
      "generation": 1,
      "_meta": {
        "my-meta-field": "foo"
      },
      "status": "YELLOW",
      "template": "my-index-template",
      "ilm_policy": "my-lifecycle-policy",
      "hidden": false,
      "system": false,
      "replicated": 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/7.17/indices-get-data-stream.html