获取自动跟踪模式 API

编辑

获取跨集群复制的自动跟踪模式

请求

编辑
resp = client.ccr.get_auto_follow_pattern()
print(resp)
response = client.ccr.get_auto_follow_pattern
puts response
const response = await client.ccr.getAutoFollowPattern();
console.log(response);
GET /_ccr/auto_follow/
resp = client.ccr.get_auto_follow_pattern(
    name="<auto_follow_pattern_name>",
)
print(resp)
const response = await client.ccr.getAutoFollowPattern({
  name: "<auto_follow_pattern_name>",
});
console.log(response);
GET /_ccr/auto_follow/<auto_follow_pattern_name>

先决条件

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

描述

编辑

此 API 获取配置的自动跟踪模式。此 API 将返回指定的自动跟踪模式集合。

路径参数

编辑
<auto_follow_pattern_name>
(可选,字符串)指定要检索的自动跟踪模式集合。 如果你没有指定名称,则 API 将返回所有集合的信息。

查询参数

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

示例

编辑

此示例检索有关名为 my_auto_follow_pattern 的自动跟踪模式集合的信息

resp = client.ccr.get_auto_follow_pattern(
    name="my_auto_follow_pattern",
)
print(resp)
response = client.ccr.get_auto_follow_pattern(
  name: 'my_auto_follow_pattern'
)
puts response
const response = await client.ccr.getAutoFollowPattern({
  name: "my_auto_follow_pattern",
});
console.log(response);
GET /_ccr/auto_follow/my_auto_follow_pattern

API 返回以下结果

{
  "patterns": [
    {
      "name": "my_auto_follow_pattern",
      "pattern": {
        "active": true,
        "remote_cluster" : "remote_cluster",
        "leader_index_patterns" :
        [
          "leader_index*"
        ],
        "leader_index_exclusion_patterns":
        [
          "leader_index_001"
        ],
        "follow_index_pattern" : "{{leader_index}}-follower"
      }
    }
  ]
}