---
title: "任务管理 | OceanBase 文档中心"
description: 任务管理 创建 Binlog 任务 用于为指定的 OceanBase 数据库租户开通 Binlog，Binlog Server 将异步地创建 N 个 Binlog 实例。执行该命令后将进行资源分配，若分配成功则立即返回 OK 包，若不足 N 个实例创建成功将返回 Warning 包。 语法 CREATE BINLOG…
---
切换语言

- 中文站 - 简体中文
- International - English
- 日本站 - 日本語

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*qvvxQ5-hqEoAAAAAAAAAAAAADiGDAQ/original) OceanBase Binlog 服务V 4.0.1 社区版

# 任务管理

更新时间：2024-11-27 23:00:00

[编辑](https://github.com/oceanbase/oblogproxy-doc/edit/V4.0.1/zh-CN/500.binlog-command/300.task-management.md)  

## 创建 Binlog 任务

用于为指定的 OceanBase 数据库租户开通 Binlog，Binlog Server 将异步地创建 N 个 Binlog 实例。执行该命令后将进行资源分配，若分配成功则立即返回 OK 包，若不足 N 个实例创建成功将返回 Warning 包。

### 语法

```sql
CREATE BINLOG [IF NOT EXISTS] FOR TENANT cluster.tenant
       [FROM timestamp] [TO USER user PASSWORD pwd]
       WITH CLUSTER URL cluster_url [, binlog_option [, binlog_option...]];

binlog_option:
      INITIAL_TRX_XID
    | INITIAL_TRX_GTID_SEQ
    | REPLICATE NUM
    | SERVER UUID

```

### 参数说明

| 参数 | 描述 |
| --- | --- |
| IF NOT EXISTS | 可选值，如果指定 `IF NOT EXISTS`，即使待创建的 Binlog 任务已存在，也不会报错；如果不指定且待创建的 Binlog 任务已存在，则系统会报错。 |
| cluster.tenant | 待创建 Binlog 任务的租户名以及租户所在的集群名。 |
| timestamp | 可选值，启动时间戳，若不指定则从当前时间戳开始。 |
| user | 可选值，OceanBase 集群系统租户（sys 租户）的用户名。若启动 Binlog Server 时已设置系统租户账密，此处可不用配置。 |
| pwd | 可选值，`user` 中配置的用户对应的密码。若启动 Binlog Server 时已设置系统租户账密，此处可不用配置。 |
| cluster_url | OceanBase 集群的 config url，配置时需使用引号包裹。可通过 `SHOW PARAMETERS LIKE 'obconfig_url';` 获得（`value` 值）。 |
| binlog_option | 可选项，用于配置 Binlog 任务的选项，配置多个选项时，使用英文逗号（`,`）间隔。配置时需使用英文逗号（`,`）与 `cluster_url` 隔开。目前可配置为：   - `INITIAL_TRX_XID`：指定起始事务的 xid 唯一标识。 - `INITIAL_TRX_GTID_SEQ`：指定起始事务对应的 gtid seq 序列号。 - `REPLICATE NUM`：指定租户的 Binlog 实例副本数量，当取值大于 1 时，Binlog 服务会随机选择一个实例副本作为主实例。 - `SERVER UUID`：手动指定 server uuid。 |

### 示例

为 `obdemo` 集群中的 `test1` 租户创建 Binlog 任务，并为该租户创建三个 Binlog 实例。

```sql
CREATE BINLOG FOR TENANT `obdemo`.`test1`
       TO USER `root` PASSWORD `********`
       WITH CLUSTER URL `http://10.10.10.1:8080/services?Action=ObRootServiceInfo&ObCluster=demo`
       , REPLICATE NUM 3;

```

## 查询 Binlog 任务

用于查询 Binlog 任务中主 Binlog 实例的 Binlog 文件和资源指标数据，若主 Binlog 实例不可用则返回空集。

### 语法

```sql
SHOW BINLOG STATUS [FOR TENANT cluster.tenant];

```

`cluster.tenant` 表示待查询 Binlog 任务的租户名以及租户所在的集群名。`FOR TENANT cluster.tenant` 为可选配置，直接执行 `SHOW BINLOG STATUS` 将输出所有 Binlog 任务的主 Binlog 实例信息，配置后将输出指定租户的主 Binlog 实例信息。命令执行示例如下：

```sql
SHOW BINLOG STATUS FOR TENANT obdemo.test1;

```

输出如下：

```shell

+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| cluster   | tenant | status                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| obdemo    | test1  | {"binlog_instance":"gldwt7bnco","resources_metrics":{"client_id":"/home/admin/oblogproxy/run/gldwt7bnco","fd_count":78,"pid":12058,"cpu_status":{"cpu_count":8,"cpu_used_ratio":0.006535947788506746},"disk_status":{"disk_total_size_mb":307048,"disk_usage_size_process_mb":0,"disk_used_ratio":0.0,"disk_used_size_mb":78830},"memory_status":{"mem_total_size_mb":63882,"mem_used_ratio":0.016514824703335763,"mem_used_size_mb":1055},"network_status":{"network_rx_bytes":288853,"network_wx_bytes":289725}},"binlog_files":[{"binlog_name":"mysql-bin.000001","binlog_size":155}]}      |
+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

```

结果集说明：

| 字段 | 说明 |
| --- | --- |
| cluster | 集群名 |
| tenant | 租户名 |
| status | 主 Binlog 实例信息 |

## 修改 Binlog 任务

用于修改指定租户下所有 Binlog 实例的参数配置，对后续新增的 Binlog 实例也生效。

### 语法

```sql
ALTER BINLOG cluster.tenant
      SET binlog_instance_option [, binlog_instance_option...];

binlog_instance_option:
      BINLOG_EXPIRE_LOGS_SECONDS
    | BINLOG_EXPIRE_LOGS_SIZE
    | FAILOVER
    | EXTRA_OBCDC_CFG

```

### 参数说明

| 参数 | 描述 |
| --- | --- |
| cluster.tenant | 待修改 Binlog 实例参数配置的租户名以及租户所在的集群名。 |
| binlog_instance_option | 指定需修改的 Binlog 实例参数，指定多个选项时，使用英文逗号（`,`）间隔。当前仅支持以下参数：   - `BINLOG_EXPIRE_LOGS_SECONDS`：Binlog 文件有效期限，默认为 259200 秒，Binlog 文件在超过设定的时长后自动失效。 - `BINLOG_EXPIRE_LOGS_SIZE`：Binlog 文件大小阈值，默认为 53687091200 byte。 - `FAILOVER`：Binlog 下线后是否自动恢复，默认为 `1`（自动恢复）。 - `EXTRA_OBCDC_CFG`：Binlog 实例的 obcdc 参数配置。 |

### 示例

```sql
ALTER BINLOG obdemo.test1 SET BINLOG_EXPIRE_LOGS_SECONDS = 518400;

```

## 释放 Binlog 任务

用于关闭指定租户的所有 Binlog 实例，同时删除已生成的存量 Binlog 文件。

### 语法

```sql
DROP BINLOG [IF EXISTS] FOR TENANT cluster.tenant;

```

`cluster.tenant` 表示待释放的 Binlog 任务所属租户名以及租户所在的集群名。

### 示例

释放 `obdemo` 集群 `test1` 租户下的 Binlog 任务。

```sql
DROP BINLOG FOR TENANT obdemo.test1;

```

 上一篇 下一篇 ![有帮助](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) 咨询热线