--- title: "Binlog 服务命令组 | OceanBase 文档中心" description: Binlog 服务命令组 Binlog 服务能收集 OceanBase 数据库的事务日志，并将其转换为 MySQL Binlog，主要用于实时数据订阅等场景。详细的 Binlog 服务介绍可参见官网 OceanBase Binlog 服务 文档。 您可以在每个命令中使用 -h/--help 选项查看命令的帮助信息。同… --- 切换语言 - 中文站 - 简体中文 - International - English - 日本站 - 日本語 文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*Qq8pT6yBPTcAAAAAAAAAAAAADiGDAQ/original) 安装部署工具 OBDV 3.2.0 社区版 # Binlog 服务命令组 更新时间：2026-04-14 17:55:42 [编辑](https://github.com/oceanbase/obd-doc/edit/V3.2.0/zh-CN/300.obd-command/550.binlog-commands.md) Binlog 服务能收集 OceanBase 数据库的事务日志，并将其转换为 MySQL Binlog，主要用于实时数据订阅等场景。详细的 Binlog 服务介绍可参见官网 [OceanBase Binlog 服务](https://www.oceanbase.com/docs/oblogproxy-doc) 文档。 您可以在每个命令中使用 `-h/--help` 选项查看命令的帮助信息。同样的，当命令执行报错时，您亦可使用 `-v/--verbose` 查看命令的详细执行过程。 #### 说明 - 本文中提到的 **业务租户** 均表示需要生成 Binlog 文件的 OceanBase 数据库中的租户。 - 目前仅支持对 V4.2.1 及之后版本的 OceanBase 数据库执行 `obd binlog` 命令，且要求 ODP 版本不小于 V4.2.1。 - 本文中提到的 **集群名** 和 **部署名** 均为通过 `obd cluster list` 命令查看到的名称。若业务租户所在集群非 obd 管理的集群，可执行接管操作进行接管，具体操作可参见 [使用 obd 接管集群](https://www.oceanbase.com/docs/community-obd-cn-1000000002691306)。 ## obd binlog create 使用该命令可为指定的租户创建 Binlog 实例。 ```shell obd binlog create [options] # example obd binlog create binlog_1 obdemo ob_mysql --replicate-num=3 ``` 参数 `binlog deploy name` 为 Binlog 服务的部署名，`oceanbase deploy name` 为业务租户所在的集群名，`oceanbase tenant` 为业务租户名。 选项说明见下表： | 选项名 | 是否必选 | 数据类型 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | --replicate-num | 否 | int | 1 | 指定租户的 Binlog 实例副本数，当取值大于 `1` 时，Binlog 服务会随机选择一个实例副本作为主实例。 | | -d/--odp/--obproxy-deployname | 否 | string | ob_deployname | 业务租户关联的 ODP 所在的部署集群名，只有在 ODP 和业务集群不归属于同一个部署集群时需要配置。 | | -p/--cdcro-password | 否 | string | 空 | 设置系统租户下 `cdcro` 用户的密码，仅在用户手动创建了 `cdcro` 用户时，需要通过该选项传入密码。 #### 说明 若业务租户所在集群的系统租户下无 `cdcro` 用户，该命令会自动在系统租户下创建 `cdcro` 用户。 | ## obd binlog drop 使用该命令可关闭指定租户的所有 Binlog 实例，同时删除已生成的存量 Binlog 文件，等同于 Binlog 服务中的 `DROP BINLOG FOR TENANT .;` 命令。 ```shell obd binlog drop [options] # example obd binlog drop binlog_1 obdemo ob_mysql ``` ## obd binlog show 使用该命令可以列表形式展示 Binlog 实例，等同于 Binlog 服务中的 `SHOW BINLOG INSTANCES FOR .;` 命令 ```shell obd binlog show [options] # example obd binlog show binlog_1 -d obdemo -t ob_mysql ``` 参数 `deploy name` 为 Binlog 服务的部署名。 选项说明见下表： | 选项名 | 是否必选 | 数据类型 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | -d/--deploy-name | 否 | string | 空 | 业务集群的部署名。 | | -t/-n/--tenant-name | 否 | string | 空 | 业务租户名。 | #### 说明 本命令中的两个选项要求要么同时进行配置，要么均不配置。单独配置任一选项均会报错。 ## obd binlog start 使用该命令可启动指定租户中的所有 Binlog 实例。 ```shell obd binlog start [options] # example obd binlog start binlog_1 obdemo ob_mysql ``` ## obd binlog stop 使用该命令可停止指定租户中的所有 Binlog 实例。 ```shell obd binlog stop [options] # example obd binlog stop binlog_1 obdemo ob_mysql ``` 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线