Spec-Zone.ru › Elasticsearch 8
›Elasticsearch Guide [8.17] ›REST API ›SQL API

API получения статуса асинхронного SQL-поиска

Справочник по новым API

Для получения самых последних данных об API, обратитесь к SQL API.

Возвращает текущий статус асинхронного SQL-поиска или сохраненного синхронного SQL-поиска.

resp = client.sql.get_async_status(
    id="FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=",
    format="json",
)
print(resp)
response = client.sql.get_async_status(
  id: 'FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=',
  format: 'json'
)
puts response
const response = await client.sql.getAsyncStatus({
  id: "FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=",
  format: "json",
});
console.log(response);
GET _sql/async/status/FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=?format=json

Запрос

GET _sql/async/status/<search_id>

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

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

Ограничения

См. Ограничения SQL.

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

<search_id>
(Обязательно, строка) Идентификатор поиска.

Тело ответа

id
(строка) Идентификатор поиска.
is_running
(Булево) Если true, поиск всё ещё выполняется. Если false, поиск завершен.
is_partial
(Булево) Если true, ответ не содержит полных результатов поиска. Если is_partial равно true и is_running равно true, поиск всё ещё выполняется. Если is_partial равно true, но is_running равно false, результаты частичные из-за ошибки или таймаута.
start_time_in_millis
(целое число) Отметка времени в миллисекундах с начала эпохи Unix, когда начался поиск. API возвращает это свойство только для выполняемых поисков.
expiration_time_in_millis
(целое число) Отметка времени в миллисекундах с начала эпохи Unix, когда Elasticsearch удалит поиск и его результаты, даже если поиск всё ещё выполняется.
completion_status
(целое число) HTTP-код состояния для поиска. API возвращает это свойство только для завершенных поисков.

© 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/get-async-sql-search-status-api.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API