原文地址: https://www.elastic.co/guide/en/elasticsearch/reference/7.7/clear-scroll-api.html, 原文档版权归 www.elastic.co 所有
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
Elasticsearch Guide [7.7] » REST APIs » Search APIs » Clear scroll API
« Scroll API Search Template »

Clear scroll APIedit

Clears the search context and results for a scrolling search.

DELETE /_search/scroll
{
    "scroll_id" : "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ=="
}

Requestedit

DELETE /_search/scroll/<scroll_id> [7.0.0] Deprecated in 7.0.0.

DELETE /_search/scroll

Path parametersedit

<scroll_id>

[7.0.0] Deprecated in 7.0.0. (Optional, string) Comma-separated list of scroll IDs to clear. To clear all scroll IDs, use _all.

Scroll IDs can be long. We recommend only specifying scroll IDs using the scroll_id request body parameter.

Query parametersedit

scroll_id

[7.0.0] Deprecated in 7.0.0. (Optional, string) Comma-separated list of scroll IDs to clear. To clear all scroll IDs, use _all.

Scroll IDs can be long. We recommend only specifying scroll IDs using the scroll_id request body parameter.

Request bodyedit

scroll_id
(Required, string or array of strings) Scroll IDs to clear. To clear all scroll IDs, use _all.

Response bodyedit

succeeded
(boolean) If true, the request succeeded. This does not indicate whether any scrolling search requests were cleared.
num_freed
(integer) Number of scrolling search requests cleared.
« Scroll API Search Template »