暂停自动跟随模式 API编辑

暂停自动跟随模式。

请求编辑

POST /_ccr/auto_follow/<auto_follow_pattern_name>/pause

先决条件编辑

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

描述编辑

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

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

路径参数编辑

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

查询参数编辑

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

示例编辑

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

response = client.ccr.pause_auto_follow_pattern(
  name: 'my_auto_follow_pattern'
)
puts response
POST /_ccr/auto_follow/my_auto_follow_pattern/pause

API 返回以下结果

{
  "acknowledged" : true
}