› › ›

API cat allocation

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

Предоставляет моментальный снимок количества фрагментов, назначенных каждому узлу данных, и их дискового пространства.

Запрос

GET /_cat/allocation/<node_id>

GET /_cat/allocation

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

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

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

<node_id>: (Необязательный, строка) Список узлов, разделенных запятыми, или имена узлов, используемые для ограничения возвращаемой информации.

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

bytes: (Необязательный, единицы измерения размера байтов) Единица измерения для отображения значений байтов.
format: (Необязательный, строка) Короткая версия заголовка HTTP accept. Допустимые значения включают JSON, YAML и т. д.
local: (Необязательный, булево) Если true, запрос получает информацию только с локального узла. По умолчанию false, что означает, что информация извлекается с узла-мастера.
master_timeout: (Необязательный, единицы измерения времени) Период ожидания узла-мастера. Если узел-мастер недоступен до истечения времени ожидания, запрос завершается ошибкой и возвращается ошибка. По умолчанию 30s. Также может быть задано значение -1, чтобы указать, что запрос никогда не должен истекать.
h: (Необязательный, строка) Список столбцов, разделенных запятыми, для отображения.
help: (Необязательный, булево) Если true, в ответе содержится справочная информация. По умолчанию false.
s: (Необязательный, строка) Список столбцов, разделенных запятыми, или псевдонимы столбцов, используемые для сортировки ответа.
v: (Необязательный, булево) Если true, ответ включает заголовки столбцов. По умолчанию false.

Тело ответа

shards

Количество первичных и реплицированных фрагментов, назначенных узлу.

shards.undesired

Количество фрагментов, запланированных для перемещения в другое место в кластере или -1, кроме как желательного баланса, используется планировщик.

write_load.forecast

Сумма прогнозов рабочей нагрузки записи индекса.

disk.indices.forecast

Сумма прогнозов размера фрагмента.

disk.indices

Дисковое пространство, используемое фрагментами узла. Не включает дисковое пространство для журнала транзакций или неназначенных фрагментов.

Этот показатель дважды учитывает дисковое пространство для жестко связанных файлов, таких как те, которые создаются при уменьшении, разделении или клонировании индекса.

disk.used

Общее дисковое пространство в использовании. Elasticsearch извлекает этот показатель из операционной системы (ОС) узла. Показатель включает дисковое пространство для:

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

В отличие от disk.indices, этот показатель не учитывает дисковое пространство для жестко связанных файлов дважды.

disk.avail

Свободное дисковое пространство, доступное для Elasticsearch. Elasticsearch извлекает этот показатель из операционной системы узла. Распределение фрагментов на основе диска использует этот показатель для назначения фрагментов узлам на основе доступного дискового пространства.

disk.total

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

disk.percent

Общий процент дискового пространства в использовании. Вычисляется как disk.used / disk.total.

host

Сетевой хост для узла. Устанавливается с помощью network.host.

ip

IP-адрес и порт узла.

node

Имя узла. Устанавливается с помощью node.name.

node.role, r, role, nodeRole

Роли узла

Примеры

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

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

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

GET /_cat/allocation?v=true

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

shards shards.undesired write_load.forecast disk.indices.forecast disk.indices disk.used disk.avail disk.total disk.percent host      ip        node    node.role
     1                0                 0.0                  260b         260b    47.3gb     43.4gb    100.7gb           46 127.0.0.1 127.0.0.1 CSUXak2 himrst

В этом ответе отображается, что один фрагмент назначен одному доступному узлу.

© 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-allocation.html