停止转换 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，则此代码表示没有与请求匹配的资源或只有部分匹配项。
示例
编辑resp = client.transform.stop_transform(
transform_id="ecommerce_transform",
)
print(resp)
response = client.transform.stop_transform( transform_id: 'ecommerce_transform' ) puts response
const response = await client.transform.stopTransform({
transform_id: "ecommerce_transform",
});
console.log(response);
POST _transform/ecommerce_transform/_stop
当转换停止时，您会收到以下结果
{
"acknowledged" : true
}