« Root API Search APIs »

› ›

脚本API

edit

脚本API

edit

使用以下API来管理、存储和测试您的脚本。

脚本支持API

edit

使用脚本支持API获取支持的脚本上下文和语言列表。

存储脚本 API

edit

使用存储脚本 API 来管理存储脚本和搜索模板。

无痛API

edit

使用 Painless execute API 在生产环境中使用之前安全地测试 Painless 脚本。

创建或更新存储脚本 API

edit

创建或更新一个存储脚本或搜索模板。

PUT _scripts/my-stored-script
{
  "script": {
    "lang": "painless",
    "source": "Math.log(_score * 2) + params['my_modifier']"
  }
}

请求

edit

PUT _scripts/

POST _scripts/

PUT _scripts//

POST _scripts//

先决条件

edit

如果启用了Elasticsearch安全功能，您必须拥有manage 集群权限才能使用此API。

路径参数

edit

<script-id>: (必需, 字符串) 存储脚本或搜索模板的标识符。必须在集群中唯一。
<context>: (可选，字符串) 脚本或搜索模板应运行的上下文。为了防止错误， API会立即在此上下文中编译脚本或模板。

查询参数

edit

context

(可选, 字符串) 脚本或搜索模板应运行的上下文。为了防止错误， API会立即在此上下文中编译脚本或模板。

如果你同时指定了这个参数和请求路径参数，API将使用请求路径参数。

master_timeout

(可选，时间单位) 等待主节点的时间段。如果在超时到期之前主节点不可用，请求将失败并返回错误。默认为30s。也可以设置为-1，表示请求不应超时。

timeout

(可选，时间单位) 在更新集群元数据后，等待集群中所有相关节点响应的时间段。如果在超时到期之前未收到响应，集群元数据更新仍然适用，但响应将表明它未被完全确认。默认为 30s。也可以设置为 -1 以指示请求不应超时。

请求体

edit

script

(必需的, 对象) 包含脚本或搜索模板、其参数及其语言。

Properties of script

lang

(必需, 字符串) 脚本语言。对于搜索模板，使用 mustache。

source

(必需, 字符串或对象) 对于脚本, 包含脚本的字符串。

对于搜索模板，包含搜索模板的对象。该对象支持与搜索API请求体相同的参数。还支持Mustache变量。请参阅搜索模板。

params

(可选, 对象) 脚本或搜索模板的参数。

删除存储脚本 API

edit

删除一个存储的脚本或搜索模板。

DELETE _scripts/my-stored-script

请求

edit

DELETE _scripts/

前提条件

edit

如果启用了Elasticsearch安全功能，您必须拥有manage 集群权限才能使用此API。

路径参数

edit

<script-id>: (必需, 字符串) 存储的脚本或搜索模板的标识符。

查询参数

edit

master_timeout: (可选，时间单位) 等待主节点的时间段。如果在超时到期之前主节点不可用，请求将失败并返回错误。默认为30s。也可以设置为-1，表示请求不应超时。
timeout: (可选，时间单位) 在更新集群元数据后，等待集群中所有相关节点响应的时间段。如果在超时到期之前未收到响应，集群元数据更新仍然适用，但响应将表明它未被完全确认。默认为 30s。也可以设置为 -1 以指示请求不应超时。