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

Также можно получить информацию о конкретной задаче. Следующий пример получает информацию о задаче oTUltX4IQMOUUVeiohTt8A:124:

GET _tasks/oTUltX4IQMOUUVeiohTt8A:124

Если задача не найдена, API возвращает 404.

Чтобы получить всех потомков конкретной задачи:

GET _tasks?parent_task_id=oTUltX4IQMOUUVeiohTt8A:123

Если родительская задача не найдена, API не возвращает 404.

Вы также можете использовать параметр запроса detailed, чтобы получить больше информации о выполняемых задачах. Это полезно для различения задач, но выполняется дороже. Например, получение всех поисковых запросов с использованием параметра запроса detailed:

GET _tasks?actions=*search&detailed

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

{
  "nodes" : {
    "oTUltX4IQMOUUVeiohTt8A" : {
      "name" : "H5dfFeA",
      "transport_address" : "127.0.0.1:9300",
      "host" : "127.0.0.1",
      "ip" : "127.0.0.1:9300",
      "tasks" : {
        "oTUltX4IQMOUUVeiohTt8A:464" : {
          "node" : "oTUltX4IQMOUUVeiohTt8A",
          "id" : 464,
          "type" : "transport",
          "action" : "indices:data/read/search",
          "description" : "indices[test], types[test], search_type[QUERY_THEN_FETCH], source[{\"query\":...}]",
          "start_time_in_millis" : 1483478610008,
          "running_time_in_nanos" : 13991383,
          "cancellable" : true,
          "cancelled" : false
        }
      }
    }
  }
}

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

API задач также можно использовать для ожидания завершения конкретной задачи. Следующий вызов будет ожидать 10 секунд или до завершения задачи с идентификатором oTUltX4IQMOUUVeiohTt8A:12345.

GET _tasks/oTUltX4IQMOUUVeiohTt8A:12345?wait_for_completion=true&timeout=10s

Вы также можете дождаться завершения всех задач определенных типов действий. Эта команда будет ждать завершения всех задач reindex:

GET _tasks?actions=*reindex&wait_for_completion=true&timeout=10s

Если задача длительного выполнения поддерживает отмену, ее можно отменить с помощью API отмены задач. Следующий пример отменяет задачу oTUltX4IQMOUUVeiohTt8A:12345:

POST _tasks/oTUltX4IQMOUUVeiohTt8A:12345/_cancel

Команда отмены задач поддерживает те же параметры выбора задач, что и команда списка задач, поэтому можно отменять несколько задач одновременно. Например, следующая команда отменяет все задачи переиндексации, выполняющиеся на узлах nodeId1 и nodeId2.

POST _tasks/_cancel?nodes=nodeId1,nodeId2&actions=*reindex

Задача может продолжать выполняться некоторое время после отмены, поскольку она может не иметь возможности безопасно остановить свою текущую активность сразу, или потому, что Elasticsearch должен завершить свою работу над другими задачами, прежде чем обработать отмену. API списка задач продолжит отображать эти отмененные задачи до их завершения. Флаг cancelled в ответе на API списка задач указывает, что команда отмены была обработана, и задача остановится как можно скорее. Для устранения неполадок, почему отмененная задача не завершается быстро, используйте API списка задач с параметром ?detailed для определения других задач, которые система выполняет, а также используйте API «горячие потоки узлов» узлов для получения подробной информации о работе системы вместо завершения отмененной задачи.

Списки задач, возвращаемые командами API задач, можно сгруппировать по узлам (по умолчанию) или по родительским задачам с помощью параметра group_by. Следующая команда изменит группировку на родительские задачи:

GET _tasks?group_by=parents

Группировку можно отключить, указав none в качестве параметра group_by:

GET _tasks?group_by=none

Заголовок X-Opaque-Id, при указании в заголовке HTTP-запроса, будет возвращен также в заголовке ответа, а также в поле headers для информации о задаче. Это позволяет отслеживать определенные вызовы или связывать определенные задачи с клиентом, который их запустил:

curl -i -H "X-Opaque-Id: 123456" "http://localhost:9200/_tasks?group_by=parents"

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

HTTP/1.1 200 OK
X-Opaque-Id: 123456 
content-type: application/json; charset=UTF-8
content-length: 831

{
  "tasks" : {
    "u5lcZHqcQhu-rUoFaqDphA:45" : {
      "node" : "u5lcZHqcQhu-rUoFaqDphA",
      "id" : 45,
      "type" : "transport",
      "action" : "cluster:monitor/tasks/lists",
      "start_time_in_millis" : 1513823752749,
      "running_time_in_nanos" : 293139,
      "cancellable" : false,
      "headers" : {
        "X-Opaque-Id" : "123456" 
      },
      "children" : [
        {
          "node" : "u5lcZHqcQhu-rUoFaqDphA",
          "id" : 46,
          "type" : "direct",
          "action" : "cluster:monitor/tasks/lists[n]",
          "start_time_in_millis" : 1513823752750,
          "running_time_in_nanos" : 92133,
          "cancellable" : false,
          "parent_task_id" : "u5lcZHqcQhu-rUoFaqDphA:45",
          "headers" : {
            "X-Opaque-Id" : "123456" 
          }
        }
      ]
    }
  }
}