› › ›

API управления задачами cat

API управления задачами cat — новый и всё ещё считается бета-функцией. API может меняться несовместимым обратным образом. Статус функции см. в #51628.

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

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

Запрос

GET /_cat/tasks

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

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

Описание

API управления задачами cat возвращает информацию о задачах, выполняемых в настоящее время на одном или нескольких узлах кластера. Это более компактный вид JSON API управления задачами.

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

detailed: (Необязательно, логическое значение) Если true, в ответе содержится подробная информация о восстановлении фрагментов. По умолчанию false.
format: (Необязательно, строка) Короткая версия заголовка HTTP accept. Допустимые значения включают JSON, YAML и т. д.
h: (Необязательно, строка) Список имен столбцов через запятую для отображения.
help: (Необязательно, логическое значение) Если true, в ответе содержится справочная информация. По умолчанию false.
nodes: (Необязательно, строка) Список идентификаторов или имен узлов через запятую, используемых для ограничения ответа. Поддерживает выражения с подстановкой (*).
parent_task_id: (Необязательно, строка) Идентификатор родительской задачи, используемый для ограничения ответа.
s: (Необязательно, строка) Список имен столбцов или псевдонимов столбцов через запятую для сортировки ответа.
time: (Необязательно, единицы измерения времени) Единица измерения для отображения значений времени.
v: (Необязательно, логическое значение) Если true, в ответе содержатся заголовки столбцов. По умолчанию false.

Коды ответов

404 (Отсутствующие ресурсы): Если <task_id> указан, но не найден, этот код указывает, что нет ресурсов, соответствующих запросу.

Примеры

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

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

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

GET _cat/tasks?v=true

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

action                         task_id                    parent_task_id             type      start_time    timestamp running_time ip             node
cluster:monitor/tasks/lists[n] oTUltX4IQMOUUVeiohTt8A:124 oTUltX4IQMOUUVeiohTt8A:123 direct    1458585884904 01:48:24  44.1micros   127.0.0.1:9300 oTUltX4IQMOUUVeiohTt8A
cluster:monitor/tasks/lists    oTUltX4IQMOUUVeiohTt8A:123 -                          transport 1458585884904 01:48:24  186.2micros  127.0.0.1:9300 oTUltX4IQMOUUVeiohTt8A

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