› › ›

清除滚动 API

清除滚动搜索的搜索上下文和结果。

resp = client.clear_scroll(
    scroll_id="DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==",
)
print(resp)

response = client.clear_scroll(
  body: {
    scroll_id: 'DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ=='
  }
)
puts response

res, err := es.ClearScroll(
	es.ClearScroll.WithBody(strings.NewReader(`{
	  "scroll_id": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ=="
	}`)),
)
fmt.Println(res, err)

const response = await client.clearScroll({
  scroll_id: "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==",
});
console.log(response);

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

请求

编辑

DELETE /_search/scroll/<scroll_id> [7.0.0] 在 7.0.0 中已弃用。

DELETE /_search/scroll

路径参数

编辑

<scroll_id>: [7.0.0] 在 7.0.0 中已弃用。 (可选，字符串) 要清除的滚动 ID 的逗号分隔列表。要清除所有滚动 ID，请使用 _all。

滚动 ID 可能很长。我们建议仅使用 scroll_id 请求体参数指定滚动 ID。

查询参数

编辑

scroll_id: [7.0.0] 在 7.0.0 中已弃用。 (可选，字符串) 要清除的滚动 ID 的逗号分隔列表。要清除所有滚动 ID，请使用 _all。

滚动 ID 可能很长。我们建议仅使用 scroll_id 请求体参数指定滚动 ID。

请求体

编辑

scroll_id: (必需，字符串或字符串数组) 要清除的滚动 ID。要清除所有滚动 ID，请使用 _all。

响应体

编辑

succeeded: (布尔值) 如果 true，则请求成功。这并不表示是否清除了任何滚动搜索请求。
num_freed: (整数) 已清除的滚动搜索请求的数量。

« 滚动 API 搜索模板 API »