渲染搜索模板 API

编辑

搜索模板渲染为搜索请求主体

resp = client.render_search_template(
    id="my-search-template",
    params={
        "query_string": "hello world",
        "from": 20,
        "size": 10
    },
)
print(resp)
response = client.render_search_template(
  body: {
    id: 'my-search-template',
    params: {
      query_string: 'hello world',
      from: 20,
      size: 10
    }
  }
)
puts response
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 安全功能,则您必须至少拥有一个索引模式的 read 索引权限

路径参数

编辑
<template-id>
(必需*,字符串)要渲染的搜索模板的 ID。如果未指定 source,则需要此参数或 id 请求主体参数。

请求主体

编辑
id
(必需*,字符串)要渲染的搜索模板的 ID。如果未指定 source,则需要此参数或 <template-id> 请求路径参数。如果同时指定此参数和 <template-id> 参数,则 API 仅使用 <template-id>
params
(可选,对象)用于替换模板中 Mustache 变量的键值对。键是变量名称。值是变量值。
source
(必需*,对象)内联搜索模板。支持与搜索 API的请求主体相同的参数。这些参数也支持Mustache变量。如果未指定 id<templated-id>,则需要此参数。