スクロールのクリア（Clear scroll）

クリアスクロールAPI

スクロール検索の検索コンテキストと結果をクリアします。

Python

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

Ruby

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

Go

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

Js

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
• (整数) クリアされたスクロール検索リクエストの数。