CCR插件

更新时间：2025-08-20

插件介绍

CCR（Cross Cluster Replication）插件是BES提供的跨集群复制插件，支持将一个BES集群（Leader集群）中的数据实时复制到另一个集群（Follower集群）。

注意：只在7.10.2版本提供

插件安装

在控制台的集群详情页面，【插件配置】-> 【系统插件】中提供了CCR插件，找到CCR插件，点击安装即可完成插件安装。

注意1：安装后需要重启集群插件才可正常使用

注意2：主集群（Leader集群）、从集群（Follower集群）都需要安装

使用说明

使用前置条件：主集群（leader集群）、从集群（follower集群）都需要安装CCR插件，且集群间网络互通。

使用CCR启动、停止索引同步的步骤是：1.从集群设置连接的主集群信息、2.从集群配置同步索引、3.从集群停止同步索引，具体的操作指令与说明详见下述内容。

一、从集群设置连接的主集群信息：

该步骤是使用需要配置的第一个步骤，用于从集群（Follower集群）中配置需要连接的主集群（Leader集群）地址信息。一个从集群可以配置多个主集群（Leader集群），具体的指令与说明详见下述内容。

格式说明

Plain Text

1PUT /_cluster/settings
2{
3   "persistent": {
4      "cluster": {
5         "remote": {
6            "{主集群1-自定义名称}": {
7               "seeds": [
8                  "{主集群1节点blb ip:tcp端口}","{主集群1节点blb ip:tcp端口}","{主集群1节点blb ip:tcp端口}"
9               ]
10            },
11            "{主集群2-自定义名称}": {
12               "seeds": [
13                  "{主集群2节点ip:tcp端口}","{主集群2节点ip:tcp端口}","{主集群2节点ip:tcp端口}"
14               ]
15            }
16         }
17      }
18   }
19}

说明：

主集群ip有两种配置方式

使用vpc_blb_ip：推荐使用该方式配置，如上述配置的主集群1，配置简单且蓝绿变配后对同步无影响，由于是新增配置方式，部分存量集群可能不支持，可提工单人工处理，tcp端口为 9200

使用vpc_ip：如上述配置的主集群2，需要把主集群上所有vpc_ip全部配置到从集群，且如果集群有蓝绿操作，需要重新配置，影响同步任务，tcp端口为 9200

使用举例

Plain Text

1PUT _cluster/settings
2{
3  "persistent": {
4    "cluster": {
5      "remote": {
6        "leader-cluster1": {
7          "seeds": [
8            "192.1.1.1:9200"
9          ]
10        },
11        "leader-cluster2": {
12          "seeds": [
13            "192.1.2.4:9200", "192.1.2.5:9200", "192.1.2.6:9200"
14          ]
15        }
16      }
17    }
18  }
19}

说明：上述ip地址为示例地址，实际使用时请填写对应主集群的 vpc_blb_ip或vpc_ip

二、从集群配置同步索引：

完成上述步骤操作后，既可以在从集群（Follower集群）进行同步索引的配置操作，开启数据同步过程。

格式说明

Plain Text

1PUT /_ccr/_replication/{从集群索引名}/_start
2{
3   "leader_alias": "{主集群1-自定义名称}",
4   "leader_index": "{主集群1索引名}"
5}

注意：新建从集群同步索引名，不能是从集群已存在索引的名称

说明1：一次同步索引配置操作只能设置一个从索引

说明2：新建从集群索引和主集群关联索引的名称不需要保持一致

说明3：新建从集群同步索引，先将主集群存量索引同步到从集群中，后持续同步增量索引

使用举例

Plain Text

1PUT /_ccr/_replication/follower_index/_start
2{
3  "leader_alias": "leader-cluster1",
4  "leader_index": "leader_index"
5}

三、修改从索引配置：

索引建立同步关系后从索引的配置不可修改而是随着主索引的变化而变化，如果需要修改从索引的配置则在从集群上执行以下命令

格式说明

Plain Text

1PUT /_ccr/_replication/{从集群索引名}/_update
2{}

使用举例

修改从索引副本分片数

Plain Text

1PUT /_ccr/_replication/follow_index/_update
2{
3   "settings":{
4      "index.number_of_replicas": 2
5   }
6}

四、从集群停止同步索引：

完成上述步骤后，如果需要停止同步索引，可以在从集群（Follower集群）通过下述指令完成操作。

格式说明

Plain Text

1POST /_ccr/_replication/{从集群索引名}/_stop
2{}

使用举例

Plain Text

1POST /_ccr/_replication/follower_index/_stop
2{}

五、从集群暂停/恢复同步索引：

同步关系建立后如果想暂停同步，可以在从集群执行以下命令

格式说明

Plain Text

1POST /_ccr/_replication/{从集群索引名}/_pause 
2{}

注意：

说明1：同步关系的暂停时间不能超过12小时，否则需要重新进行同步

暂停同步后如果想要恢复，可以在从集群上执行以下命令

格式说明

Plain Text

1POST /_ccr/_replication/{从集群索引名}/_resume
2{}

六、创建/删除auto-follow自动同步

如果想要按特定的索引名称规则去自动同步主集群上的索引，可以使用自动同步功能，在从集群执行以下命令

格式说明

Plain Text

1POST /_ccr/_replication/_autofollow 
2{
3    "leader_alias": "{主集群1-自定义名称}",
4    "name": "{同步规则名称}",
5    "pattern": "{主集群1索引匹配规则}"
6}

注意：

说明1：按照设置的匹配规则同步主集群索引时，如果从集群上存在同名索引，则从集群会跳过该索引

说明2：可以使用相同命令更新索引匹配规则

使用举例

Plain Text

1POST /_ccr/_replication/_autofollow 
2{
3   "leader_alias": "leader-cluster1",
4   "name": "auto-follow-pattern-1",
5   "pattern": "test*"
6}

如果想要停止按名称规则去同步主集群索引，需要删除该规则，在从集群上执行以下命令

格式说明

Plain Text

1DELETE /_ccr/_replication/_autofollow
2{
3   "leader_alias" : "{主集群1-自定义名称}",
4   "name": "{同步规则名称}"
5}

使用举例

Plain Text

1DELETE /_ccr/_replication/_autofollow
2{
3   "leader_alias" : "leader-cluster1",
4   "name": "auto-follow-pattern-1"
5}

七、查看同步规则

设置同步规则之后，可以在从集群通过下述命令查看配置的所有规则

格式说明

Plain Text

1GET /_ccr/_replication/autofollow_stats

响应示例

Plain Text

1{
2   "num_success_start_replication": 2,
3   "num_failed_start_replication": 0,
4   "num_failed_leader_calls": 0,
5   "failed_indices":[
6      
7   ],
8   "autofollow_stats":[
9      {
10         "name":"auto-follow-pattern-1",
11         "pattern":"test*",
12         "num_success_start_replication": 2,
13         "num_failed_start_replication": 0,
14         "num_failed_leader_calls": 0,
15         "failed_indices":[
16            
17         ]
18      }
19   ]
20}

八、查看同步状态

支持查看集群级、索引级、分片级的同步状态，在从集群执行命令

集群级同步状态

格式说明

Plain Text

1GET /_ccr/_replication/follower_stats

响应示例

Plain Text

1{
2   "num_syncing_indices": 2,
3   "num_bootstrapping_indices": 0,
4   "num_paused_indices": 0,
5   "num_failed_indices": 0,
6   "num_shard_tasks": 2,
7   "num_index_tasks": 2,
8   "operations_written": 3,
9   "operations_read": 3,
10   "failed_read_requests": 0,
11   "throttled_read_requests": 0,
12   "failed_write_requests": 0,
13   "throttled_write_requests": 0,
14   "follower_checkpoint": 1,
15   "leader_checkpoint": 1,
16   "total_write_time_millis": 2290,
17   "index_stats":{
18      "follower-index-1":{
19         "operations_written": 2,
20         "operations_read": 2,
21         "failed_read_requests": 0,
22         "throttled_read_requests": 0,
23         "failed_write_requests": 0,
24         "throttled_write_requests": 0,
25         "follower_checkpoint": 1,
26         "leader_checkpoint": 1,
27         "total_write_time_millis": 1355
28      },
29      "follower-index-2":{
30         "operations_written": 1,
31         "operations_read": 1,
32         "failed_read_requests": 0,
33         "throttled_read_requests": 0,
34         "failed_write_requests": 0,
35         "throttled_write_requests": 0,
36         "follower_checkpoint": 0,
37         "leader_checkpoint": 0,
38         "total_write_time_millis": 935
39      }
40   }
41}

注意：

说明1：第一层的follower_checkpoint和leader_checkpoint代表集群上所有建立同步关系索引的同步进度之和，相等则代表该集群上所有索引均已完全同步

索引级同步状态

格式说明

Plain Text

1GET /_ccr/_replication/{从集群索引名}/_status

响应示例

Plain Text

1{
2  "status" : "SYNCING",
3  "reason" : "User initiated",
4  "leader_alias" : "leader",
5  "leader_index" : "leader-index",
6  "follower_index" : "follower-index",
7  "syncing_details" : {
8    "leader_checkpoint" : 19,
9    "follower_checkpoint" : 19,
10    "seq_no" : 0
11  }
12}

注意：

说明1：leader_checkpoint和follower_checkpoint如果值相同代表索引完全同步

分片级同步状态

如果想进一步看分片级同步状态，则需要在上述命令后加上&verbose=true参数

格式说明

Plain Text

1GET /_ccr/_replication/{从集群索引名}/_status&verbose=true

响应示例

Plain Text

1{
2  "status" : "SYNCING",
3  "reason" : "User initiated",
4  "leader_alias" : "leader",
5  "leader_index" : "leader-index",
6  "follower_index" : "follower-index",
7  "syncing_details" : {
8    "leader_checkpoint" : 7,
9    "follower_checkpoint" : 7,
10    "seq_no" : 8
11  },
12  "shard_replication_details": [
13      {
14         "shard_id": "[follower-index][0]",
15         "syncing_task_details": {
16            "leader_checkpoint": 7,
17            "follower_checkpoint": 7,
18            "seq_no": 8
19         }
20      }
21   ]
22}

compression-zstd插件

限流插件

Elasticsearch BES

Elasticsearch BES

CCR插件

插件介绍

插件安装

使用说明

一、从集群设置连接的主集群信息：

格式说明

使用举例

二、从集群配置同步索引：

格式说明

使用举例

三、修改从索引配置：

格式说明

使用举例

四、从集群停止同步索引：

格式说明

使用举例

五、从集群暂停/恢复同步索引：

格式说明

格式说明

六、创建/删除auto-follow自动同步

格式说明

使用举例

格式说明

使用举例

七、查看同步规则

格式说明

响应示例

八、查看同步状态

集群级同步状态

格式说明

响应示例

索引级同步状态

格式说明

响应示例

分片级同步状态

格式说明

响应示例