暂停追踪者 API

编辑

暂停跨集群复制追踪者索引。

请求

编辑
resp = client.ccr.pause_follow(
    index="<follower_index>",
)
print(resp)
const response = await client.ccr.pauseFollow({
  index: "<follower_index>",
});
console.log(response);
POST /<follower_index>/_ccr/pause_follow

先决条件

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

描述

编辑

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

路径参数

编辑
<follower_index>
(必需,字符串) 追踪者索引的名称。

查询参数

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

示例

编辑

此示例暂停名为 follower_index 的追踪者索引

resp = client.ccr.pause_follow(
    index="follower_index",
)
print(resp)
response = client.ccr.pause_follow(
  index: 'follower_index'
)
puts response
const response = await client.ccr.pauseFollow({
  index: "follower_index",
});
console.log(response);
POST /follower_index/_ccr/pause_follow

API 返回以下结果

{
  "acknowledged" : true
}