Асинхронный поиск

Выполняет асинхронный запрос поиска. Он принимает те же параметры и тело запроса, что и API поиска API поиска.

POST /sales*/_async_search?size=0
{
  "sort": [
    { "date": { "order": "asc" } }
  ],
  "aggs": {
    "sale_date": {
      "date_histogram": {
        "field": "date",
        "calendar_interval": "1d"
      }
    }
  }
}

Ответ содержит идентификатор выполняемого поиска. Вы можете использовать этот идентификатор для получения окончательных результатов поиска впоследствии. Текущие доступные результаты поиска возвращаются в рамках объекта response.

{
  "id" : "FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=", 
  "is_partial" : true, 
  "is_running" : true, 
  "start_time_in_millis" : 1583945890986,
  "expiration_time_in_millis" : 1584377890986,
  "response" : {
    "took" : 1122,
    "timed_out" : false,
    "num_reduce_phases" : 0,
    "_shards" : {
      "total" : 562, 
      "successful" : 3, 
      "skipped" : 0,
      "failed" : 0
    },
    "hits" : {
      "total" : {
        "value" : 157483, 
        "relation" : "gte"
      },
      "max_score" : null,
      "hits" : [ ]
    }
  }
}

Можно заблокировать и дождаться завершения поиска в течение определенного таймаута, передав параметр wait_for_completion_timeout, который по умолчанию имеет значение 1 секунды. Если асинхронный поиск завершается в течение этого таймаута, в ответе не будет содержаться ID, так как результаты не сохраняются в кластере. Параметр keep_on_completion, который по умолчанию имеет значение false, может быть установлен в значение true, чтобы запросить сохранение результатов для последующего извлечения даже при завершении поиска в течение таймаута wait_for_completion_timeout.

Вы также можете указать, как долго асинхронный поиск должен быть доступен в кластере, используя параметр keep_alive, который по умолчанию имеет значение 5d (пять дней). Незавершенные асинхронные поиски и сохраненные результаты поиска удаляются по истечении этого срока.

API отправки асинхронного поиска поддерживает те же параметры, что и API поиска, хотя у некоторых из них другие значения по умолчанию:

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

GET /_async_search/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=

{
  "id" : "FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=",
  "is_partial" : true, 
  "is_running" : true, 
  "start_time_in_millis" : 1583945890986,
  "expiration_time_in_millis" : 1584377890986, 
  "response" : {
    "took" : 12144,
    "timed_out" : false,
    "num_reduce_phases" : 46, 
    "_shards" : {
      "total" : 562,
      "successful" : 188, 
      "skipped" : 0,
      "failed" : 0
    },
    "hits" : {
      "total" : {
        "value" : 456433,
        "relation" : "eq"
      },
      "max_score" : null,
      "hits" : [ ]
    },
    "aggregations" : { 
      "sale_date" :  {
        "buckets" : []
      }
    }
  }
}

Параметр wait_for_completion_timeout также может быть передан при вызове API получения асинхронного поиска, чтобы дождаться завершения поиска до указанного таймаута. Окончательные результаты будут возвращены, если они доступны до истечения таймаута, в противном случае будут возвращены текущие доступные результаты по истечении таймаута. По умолчанию таймаут не установлен, что означает, что текущие доступные результаты будут возвращены без дополнительного ожидания.

Параметр keep_alive указывает, как долго асинхронный поиск должен быть доступен в кластере. При отсутствии указания будет использоваться значение keep_alive, установленное соответствующим запросом отправки асинхронного запроса. В противном случае, можно переопределить это значение и продлить срок действия запроса. При истечении этого срока поиск, если он всё ещё выполняется, будет отменён. Если поиск завершён, сохранённые результаты будут удалены.

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

GET /_async_search/status/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=

{
  "id" : "FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=",
  "is_running" : true,
  "is_partial" : true,
  "start_time_in_millis" : 1583945890986,
  "expiration_time_in_millis" : 1584377890986,
  "_shards" : {
      "total" : 562,
      "successful" : 188, 
      "skipped" : 0,
      "failed" : 0
  }
}

Для завершенного асинхронного поиска ответ статуса содержит дополнительное поле completion_status, которое показывает код состояния завершенного асинхронного поиска.

{
  "id" : "FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=",
  "is_running" : false,
  "is_partial" : false,
  "start_time_in_millis" : 1583945890986,
  "expiration_time_in_millis" : 1584377890986,
  "_shards" : {
      "total" : 562,
      "successful" : 562,
      "skipped" : 0,
      "failed" : 0
  },
 "completion_status" : 200 
}

{
  "id" : "FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=",
  "is_running" : false,
  "is_partial" : true,
  "start_time_in_millis" : 1583945890986,
  "expiration_time_in_millis" : 1584377890986,
  "_shards" : {
      "total" : 562,
      "successful" : 450,
      "skipped" : 0,
      "failed" : 112
  },
 "completion_status" : 503 
}

API удаления асинхронного поиска позволяет вручную удалить асинхронный поиск по ID. Если поиск всё ещё выполняется, запрос поиска будет отменён. В противном случае, сохранённые результаты поиска будут удалены.

DELETE /_async_search/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=

Если включены функции безопасности Elasticsearch, удаление конкретного асинхронного поиска ограничено: * Авторизованным пользователем, который отправил исходный запрос поиска. * Пользователями, имеющими привилегию cancel_task кластера.