停止转换 API
编辑停止转换 API编辑
停止一个或多个转换。
请求编辑
POST _transform/<transform_id>/_stop
POST _transform/<transform_id1>,<transform_id2>/_stop
POST _transform/_all/_stop
先决条件编辑
需要 manage_transform 集群权限。此权限包含在 transform_admin 内置角色中。
路径参数编辑
-
<transform_id> - (必需，字符串) 转换的标识符。要停止多个转换，请使用逗号分隔的列表或通配符表达式。要停止所有转换，请使用
_all或*作为标识符。
查询参数编辑
-
allow_no_match -
(可选，布尔值) 指定当请求
- 包含通配符表达式，并且没有匹配的转换。
- 包含
_all字符串或没有标识符，并且没有匹配项。 - 包含通配符表达式，并且只有部分匹配项。
默认值为
true，当没有匹配项时，返回成功的确认消息。当只有部分匹配项时，API 会停止相应的转换。例如，如果请求包含test-id1*,test-id2*作为标识符，并且没有与test-id2*匹配的转换，API 仍然会停止与test-id1*匹配的转换。如果此参数为
false，当没有匹配项或只有部分匹配项时，请求将返回404状态代码。 -
force - (可选，布尔值) 设置为
true以停止失败的转换，或强制停止未响应初始停止请求的转换。 -
timeout - (可选，时间值) 如果
wait_for_completion=true，API 会阻塞（最多）指定的持续时间，同时等待转换停止。如果超过timeout时间，API 会抛出超时异常。即使抛出超时异常，停止请求仍在处理中，最终会将转换移至STOPPED。超时只是意味着 API 调用本身在等待状态更改时超时。默认为30s。 -
wait_for_checkpoint - (可选，布尔值) 如果设置为
true，则转换在当前检查点完成之前不会完全停止。如果设置为false，则转换会尽快停止。默认为false。 -
wait_for_completion - (可选，布尔值) 如果设置为
true，则会导致 API 阻塞，直到索引器状态完全停止。如果设置为false，则 API 会立即返回，索引器将在后台异步停止。默认为false。
响应代码编辑
-
404(缺少资源) - 如果
allow_no_match为false，则此代码表示没有与请求匹配的资源，或者请求只有部分匹配项。
示例编辑
response = client.transform.stop_transform( transform_id: 'ecommerce_transform' ) puts response
POST _transform/ecommerce_transform/_stop
当转换停止时，您将收到以下结果
{
"acknowledged" : true
}