› › ›

API cat segments

API cat предназначены только для использования человеком с помощью командной строки или консоли Kibana. Они не предназначены для использования приложениями. Для использования приложениями используйте API фрагментов индекса.

Возвращает низкоуровневую информацию о Lucene фрагментах в фрагментах индексных фрагментов, аналогично API фрагментов индексов.

Для потоков данных API возвращает информацию об индексах-источниках потока данных.

Запрос

GET /_cat/segments/<target>

GET /_cat/segments

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

Если функции безопасности Elasticsearch включены, у вас должен быть monitor или manage привилегия кластера для использования этого API. Вам также должен быть monitor или manage привилегия индекса для любого потока данных, индекса или псевдонима, который вы получаете.

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

<target>: (Необязательный, строка) Список данных, индексов и псевдонимов, разделенных запятыми, используемых для ограничения запроса. Поддерживаются маски (*). Для выбора всех потоков данных и индексов опустите этот параметр или используйте * или _all.

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

bytes

(Необязательно, единицы размера байтов) Единица, используемая для отображения значений байтов.

format

(Необязательно, строка) Короткое представление заголовка HTTP accept. Допустимые значения включают JSON, YAML и т.д.

h

(Необязательно, строка) Список имен столбцов, разделенных запятыми, для отображения.

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

Допустимые столбцы:

index, i, idx

(По умолчанию) Название индекса.

shard, s, sh

(По умолчанию) Имя фрагмента.

prirep, p, pr, primaryOrReplica

(По умолчанию) Тип фрагмента. Возвращаемые значения — primary или replica.

ip

(По умолчанию) IP-адрес фрагмента фрагмента, например 127.0.1.1.

segment

(По умолчанию) Имя сегмента, например _0. Имя сегмента получено из номера генерации сегмента и используется внутри для создания имен файлов в каталоге фрагмента.

generation

(По умолчанию) Номер генерации, например 0. Elasticsearch увеличивает этот номер генерации для каждого записанного сегмента. Затем Elasticsearch использует это число для вывода имени сегмента. Номер генерации, такой как 0. Elasticsearch увеличивает этот номер генерации для каждого записанного сегмента. Затем Elasticsearch использует это число для вывода имени сегмента.

docs.count

(По умолчанию) Количество документов, сообщенное Lucene. Это исключает удаленные документы и отдельно учитывает вложенные документы от их родителей. Это также исключает документы, которые были недавно индексированы и еще не принадлежат сегменту.

docs.deleted

(По умолчанию) Количество удаленных документов, сообщенных Lucene, которое может быть выше или ниже, чем количество операций удаления, которые вы выполнили. Это число не учитывает удаления, которые были выполнены недавно и еще не принадлежат сегменту. Удаленные документы очищаются процессом автоматической слияния, если это имеет смысл. Кроме того, Elasticsearch создает дополнительные удаленные документы для отслеживания внутренней истории операций над фрагментом.

size

(По умолчанию) Дисковое пространство, используемое сегментом, например 50kb.

size.memory

(По умолчанию) Байты данных сегмента, хранящиеся в памяти для эффективного поиска, например 1264.

Значение -1 указывает, что Elasticsearch не смог вычислить это число.

committed

(По умолчанию) Если true, сегменты синхронизируются на диске. Синхронизированные сегменты могут пережить жесткий перезапуск.

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

searchable

(По умолчанию) Если true, сегмент доступен для поиска.

Если false, сегмент, скорее всего, был записан на диск, но для поиска требуется обновление.

version

(По умолчанию) Версия Lucene, используемая для записи сегмента.

compound

(По умолчанию) Если true, сегмент хранится в составном файле. Это означает, что Lucene объединил все файлы из сегмента в один файл для экономии дескрипторов файлов.

id

Идентификатор узла, например k0zy.

help

(Необязательно, логическое значение) Если true, в ответ включается справочная информация. По умолчанию false.

s

(Необязательно, строка) Список имен столбцов или псевдонимов столбцов, используемых для сортировки ответа.

v

(Необязательно, логическое значение) Если true, в ответ включаются заголовки столбцов. По умолчанию false.

Примеры

GET /_cat/segments?v=true

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

index shard prirep ip        segment generation docs.count docs.deleted size size.memory committed searchable version compound
test  0     p      127.0.0.1 _0               0          1            0  3kb        2042 false     true       8.11.3   true
test1 0     p      127.0.0.1 _0               0          1            0  3kb        2042 false     true       8.11.3   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/7.17/cat-segments.html