获取自动跟随模式 API编辑

获取自动跟随模式。

请求编辑

response = client.ccr.get_auto_follow_pattern
puts response
GET /_ccr/auto_follow/
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 的自动跟随模式集合的信息

response = client.ccr.get_auto_follow_pattern(
  name: 'my_auto_follow_pattern'
)
puts 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"
      }
    }
  ]
}