暂停跟随者 API编辑

暂停跟随者索引。

请求编辑

POST /<follower_index>/_ccr/pause_follow

先决条件编辑

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

描述编辑

此 API 会暂停跟随者索引。当此 API 返回时,跟随者索引将不会从领导者索引中获取任何其他操作。您可以使用 恢复跟随者 API 恢复跟随。暂停和恢复跟随者索引可用于更改跟随任务的配置。

路径参数编辑

<follower_index>
(必填,字符串)跟随者索引的名称。

查询参数编辑

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

示例编辑

此示例暂停名为 follower_index 的跟随者索引

response = client.ccr.pause_follow(
  index: 'follower_index'
)
puts response
POST /follower_index/_ccr/pause_follow

API 返回以下结果

{
  "acknowledged" : true
}