New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
« 获取追随者统计信息 API 创建自动追随模式 API »
Elastic 文档 ›Elasticsearch 指南 [8.17] ›REST API ›跨集群复制 API

获取追随者信息 API

编辑

获取追随者信息 API

编辑

检索有关所有跨集群复制追随者索引的信息。

请求

编辑
resp = client.ccr.follow_info(
    index="<index>",
)
print(resp)
const response = await client.ccr.followInfo({
  index: "<index>",
});
console.log(response);
GET /<index>/_ccr/info
Copy as curlTry in Elastic 

先决条件

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

描述

编辑

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

路径参数

编辑
<index>
(必需，字符串) 一个逗号分隔的追随者索引模式列表。

查询参数

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

响应体

编辑
follower_indices

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

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

(对象) 一个封装跨集群复制参数的对象。 如果追随者索引的 status 为 paused，则此对象将被省略。

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。

示例

编辑

此示例检索追随者信息

resp = client.ccr.follow_info(
    index="follower_index",
)
print(resp)
response = client.ccr.follow_info(
  index: 'follower_index'
)
puts response
const response = await client.ccr.followInfo({
  index: "follower_index",
});
console.log(response);
GET /follower_index/_ccr/info
Copy as curlTry in Elastic 

如果追随者索引为 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"
    }
  ]
}
« 获取追随者统计信息 API 创建自动追随模式 API »

On this page

Was this helpful?
Feedback