› › ›

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 использует это число для получения имени фрагмента.

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

ID узла, например k0zy.

help

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

s

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

v

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

Примеры

resp = client.cat.segments(
    v=True,
)
print(resp)

response = client.cat.segments(
  v: true
)
puts response

const response = await client.cat.segments({
  v: "true",
});
console.log(response);

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           0 false     true       9.12.0   true
test1 0     p      127.0.0.1 _0               0          1            0  3kb           0 false     true       9.12.0   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/cat-segments.html