検索テンプレートのレンダリング（Render search template）

検索テンプレートAPI

検索テンプレートを検索リクエストボディとしてレンダリングします。

Python

resp = client.render_search_template(
   id="my-search-template",
   params={
   "query_string": "hello world",
   "from": 20,
   "size": 10
   },
)
print(resp)

Ruby

response = client.render_search_template(
  body: {
   id: 'my-search-template',
   params: {
   query_string: 'hello world',
   from: 20,
   size: 10
   }
  }
)
puts response

Js

const response = await client.renderSearchTemplate({
  id: "my-search-template",
  params: {
   query_string: "hello world",
   from: 20,
   size: 10,
  },
});
console.log(response);

コンソール

POST _render/template
{
  "id": "my-search-template",
  "params": {
   "query_string": "hello world",
   "from": 20,
   "size": 10
  }
}

リクエスト

GET _render/template

GET _render/template/<template-id>

POST _render/template

POST _render/template/<template-id>

前提条件

• Elasticsearchのセキュリティ機能が有効になっている場合、少なくとも1つのインデックスパターンに対してread インデックス権限を持っている必要があります。

パスパラメータ

• <template-id>
• (必須*, 文字列) レンダリングする検索テンプレートのID。sourceが指定されていない場合、このパラメータまたはidリクエストボディパラメータが必要です。

リクエストボディ

• id
• (必須*, 文字列) レンダリングする検索テンプレートのID。sourceが指定されていない場合、このパラメータまたは<template-id>リクエストパスパラメータが必要です。両方のパラメータを指定した場合、APIは<template-id>のみを使用します。
• params
• (オプション、オブジェクト) テンプレート内のMustache変数を置き換えるために使用されるキーと値のペア。キーは変数名、値は変数の値です。
• source
• (必須*, オブジェクト) インライン検索テンプレート。 検索APIのリクエストボディと同じパラメータをサポートします。これらのパラメータはMustache変数もサポートします。idまたは<templated-id>が指定されていない場合、このパラメータは必須です。