获取跟随者信息 API编辑

检索有关所有跟随者索引的信息。

请求编辑

GET /<index>/_ccr/info

先决条件编辑

  • 如果启用了 Elasticsearch 安全功能,则您必须具有 monitor 集群权限。有关更多信息,请参阅安全权限

描述编辑

此 API 列出每个跟随者索引的参数和状态。例如,结果包括跟随者索引名称、领导者索引名称、复制选项以及跟随者索引是处于活动状态还是暂停状态。

路径参数编辑

<index>
(必填,字符串)以逗号分隔的跟随者索引模式列表。

查询参数编辑

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

响应正文编辑

follower_indices

(数组)跟随者索引统计信息数组。

follower_indices 中对象的属性
follower_index
(字符串)跟随者索引的名称。
leader_index
(字符串)被跟随的领导者集群中索引的名称。
parameters

(对象)封装跨集群复制参数的对象。如果跟随者索引的 statuspaused,则省略此对象。

parameters 的属性
max_outstanding_read_requests
(长整型)来自远程集群的未完成读取请求的最大数量。
max_outstanding_write_requests
(整数)跟随者上未完成写入请求的最大数量。
max_read_request_operation_count
(整数)每次从远程集群读取时要拉取的最大操作数。
max_read_request_size
字节值)每次从远程集群拉取一批操作时,读取的最大字节大小。
max_retry_delay
时间值)重试异常失败的操作之前的最长等待时间。重试时采用指数退避策略。
max_write_buffer_count
(整数)可以排队等待写入的最大操作数。达到此限制时,将延迟从远程集群读取数据,直到排队的操作数低于限制为止。
max_write_buffer_size
字节值)可以排队等待写入的操作的最大总字节数。达到此限制时,将延迟从远程集群读取数据,直到排队的操作的总字节数低于限制为止。
max_write_request_operation_count
(整数)在跟随者上执行的每个批量写入请求的最大操作数。
max_write_request_size
字节值)在跟随者上执行的每个批量写入请求的最大操作总字节数。
read_poll_timeout
时间值)当跟随者索引与领导者索引同步时,在远程集群上等待新操作的最长时间。超时后,对操作的轮询将返回到跟随者,以便它可以更新一些统计信息,然后跟随者立即尝试再次从领导者读取数据。
remote_cluster
(字符串)包含领导者索引的远程集群
status
(字符串)索引跟随是 active 还是 paused

示例编辑

此示例检索跟随者信息

response = client.ccr.follow_info(
  index: 'follower_index'
)
puts response
GET /follower_index/_ccr/info

如果跟随者索引为 active,则 API 返回以下结果

{
  "follower_indices": [
    {
      "follower_index": "follower_index",
      "remote_cluster": "remote_cluster",
      "leader_index": "leader_index",
      "status": "active",
      "parameters": {
        "max_read_request_operation_count": 5120,
        "max_read_request_size": "32mb",
        "max_outstanding_read_requests": 12,
        "max_write_request_operation_count": 5120,
        "max_write_request_size": "9223372036854775807b",
        "max_outstanding_write_requests": 9,
        "max_write_buffer_count": 2147483647,
        "max_write_buffer_size": "512mb",
        "max_retry_delay": "500ms",
        "read_poll_timeout": "1m"
      }
    }
  ]
}

如果跟随者索引为 paused,则 API 返回以下结果

{
  "follower_indices": [
    {
      "follower_index": "follower_index",
      "remote_cluster": "remote_cluster",
      "leader_index": "leader_index",
      "status": "paused"
    }
  ]
}