Spec-Zone.ru › Elasticsearch 8
›Elasticsearch Guide [8.17] ›REST APIs ›ES|QL APIs

ES|QL async query delete API

New API reference

For the most up-to-date API details, refer to ES|QL APIs.

The ES|QL async query delete API is used to manually delete an async query by ID. If the query is still running, the query will be cancelled. Otherwise, the stored results are deleted.

DELETE /query/async/FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=

Request

DELETE /_query/async/<query_id>

Prerequisites

  • If the Elasticsearch security features are enabled, only the following users can use this API to delete a query:

    • The authenticated user that submitted the original query request
    • Users with the cancel_task cluster privilege

Path parameters

<query_id>

(Required, string) Identifier for the query to delete.

A query ID is provided in the ES|QL async query API's response for a query that does not complete in the awaited time. A query ID is also provided if the request’s keep_on_completion parameter is true.

© 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/esql-async-query-delete-api.html

Spec-Zone.ru

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