暂停自动跟踪模式 API

编辑

暂停跨集群复制自动跟踪模式

请求

编辑

POST /_ccr/auto_follow/<auto_follow_pattern_name>/pause

先决条件

编辑
  • 如果启用了 Elasticsearch 安全功能,您必须在包含追随者索引的集群上拥有 manage_ccr 集群权限。有关更多信息,请参阅安全权限

描述

编辑

此 API 暂停自动跟踪模式。当此 API 返回时,自动跟踪模式将处于非活动状态,并且会忽略远程集群上创建的任何与自动跟踪模式匹配的新索引。在获取自动跟踪模式 API中,暂停的自动跟踪模式的 active 字段设置为 false

您可以使用恢复自动跟踪模式 API恢复自动跟踪。一旦恢复,自动跟踪模式将再次处于活动状态,并自动为远程集群上与其模式匹配的新创建的索引配置追随者索引。在模式暂停期间创建的远程索引也会被跟踪,除非它们在此期间已被删除或关闭。

路径参数

编辑
<auto_follow_pattern_name>
(必需,字符串)要暂停的自动跟踪模式的名称。

查询参数

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

示例

编辑

此示例暂停名为 my_auto_follow_pattern 的自动跟踪模式

resp = client.ccr.pause_auto_follow_pattern(
    name="my_auto_follow_pattern",
)
print(resp)
response = client.ccr.pause_auto_follow_pattern(
  name: 'my_auto_follow_pattern'
)
puts response
const response = await client.ccr.pauseAutoFollowPattern({
  name: "my_auto_follow_pattern",
});
console.log(response);
POST /_ccr/auto_follow/my_auto_follow_pattern/pause

该 API 返回以下结果

{
  "acknowledged" : true
}