Oceanbase同步
February 26, 2024About 12 min
Oceanbase同步
SDK类名:/active/Oceanbase;
同步规则 - 列表
SDK方法名:listOceanRule;
URL
/ocean/rule
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | [0] 操作成功。 | |||
info_list | Array | ||||
src_db_name | String | db2_1 | |||
tgt_db_name | String | db2_2 | |||
username | String | admin | |||
user_uuid | String | 1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC | |||
rule_uuid | String | 2511627B-5306-EE10-E1D3-97CC89450D89 | |||
src_db_uuid | String | 2C4C2E77-774D-C604-9A32-5038D8E590C4 | |||
tgt_db_uuid | String | 953C47CB-3F6C-E72F-DF1C-31522468A566 | |||
rule_type | Number | 61 | |||
rule_name | String | 12321 | |||
node_uuid | String | ||||
tgt_type | String | kafka | |||
db_user_map | String | ||||
row_map_mode | String | rowid | |||
map_type | String | db | |||
table_map | String | ||||
dbmap_topic | String | ||||
sync_mode | String | 1 | |||
start_scn | String | 0 | |||
storage_settings | Object | ||||
src_max_mem | String | 512 | |||
src_max_disk | String | 5000 | |||
txn_max_mem | String | 10000 | |||
tf_max_size | String | 100 | |||
max_ld_mem | String | 512 | |||
tgt_extern_table | String | ||||
table_space_map | Object | ||||
tgt_table_space | String | ||||
table_mapping_way | String | ptop | |||
table_path_map | Array | ||||
table_space_name | Array | ||||
other_settings | Object | ||||
keep_dyn_data | Number | 0 | |||
dyn_thread | Number | 1 | |||
dly_constraint_load | Number | 0 | |||
zip_level | Number | 0 | |||
ddl_cv | Number | 0 | |||
keep_bad_act | Number | 0 | |||
fill_lob_column | Number | 0 | |||
keep_seq_sync | Number | 0 | |||
keep_usr_pwd | Number | 0 | |||
convert_urp_of_key | Number | 0 | |||
ignore_foreign_key | Number | 0 | |||
gen_txn | Number | 0 | |||
error_handling | Object | ||||
irp | String | irpafterdel | |||
urp | String | toirp | |||
drp | String | ignore | |||
load_err_set | String | continue | |||
report_failed_dml | Number | 0 | |||
bw_settings | Object | ||||
bw_limit | String | ||||
strate | Null | ||||
full_sync_settings | Object | ||||
load_mode | String | direct | |||
ld_dir_opt | Number | 0 | |||
dump_thd | Number | 1 | |||
load_thd | Number | 1 | |||
try_split_part_table | Number | 1 | |||
clean_user_before_dump | Number | 0 | |||
existing_table | String | drop_to_recycle | |||
concurrent_table | String | [] | |||
full_sync_obj_filter | Object | ||||
full_sync_obj_data | Array | ||||
inc_sync_ddl_filter | Object | ||||
inc_sync_ddl_data | Array | ||||
filter_table_settings | Object | ||||
exclude_table | String | [] | |||
etl_settings | Object | ||||
etl_table | Array | ||||
create_time | Number | 1601362592 | |||
start_rule_now | Number | 1 | |||
db_map_uuid | String | ||||
dml_track | Object | ||||
enable | Number | 0 | |||
urp | Number | 0 | |||
drp | Number | 0 | |||
tmcol | String | ||||
delcol | String | ||||
kafka_time_out | String | 120000 | |||
part_load_balance | String | by_table | |||
kafka_message_encoding | String | UTF-8 | |||
kafka | Object | ||||
binary_code | String | hex | |||
is_biz_admin | Number | 1 | |||
can_del | Number | 1 | |||
can_op | Number | 1 | |||
can_up | Number | 1 | |||
total | Number | 2 |
同步规则 - 新建
SDK方法名:createOceanRule;
URL
/ocean/rule
Method
POST
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
start_rule_now | Number | 1 | |||
rule_name | String | 12321 | |||
src_db_uuid | String | 2C4C2E77-774D-C604-9A32-5038D8E590C4 | |||
tgt_type | String | db2 | |||
tgt_db_uuid | String | 953C47CB-3F6C-E72F-DF1C-31522468A566 | |||
map_type | String | db | |||
db_user_map | String | ||||
table_map | String | ||||
dbmap_topic | String | ||||
row_map_mode | String | rowid | |||
sync_mode | Number | 1 | |||
start_scn | String | ||||
kafka_time_out | String | 120000 | |||
part_load_balance | String | by_table | |||
kafka_message_encoding | String | UTF-8 | |||
kafka | Object | ||||
binary_code | String | hex | |||
dml_track | Object | ||||
enable | Number | 0 | |||
urp | Number | 0 | |||
drp | Number | 0 | |||
tmcol | String | ||||
delcol | String | ||||
storage_settings | Object | ||||
src_max_mem | String | 512 | |||
src_max_disk | String | 5000 | |||
txn_max_mem | String | 10000 | |||
tf_max_size | String | 100 | |||
max_ld_mem | String | 512 | |||
tgt_extern_table | String | ||||
other_settings | Object | ||||
keep_dyn_data | Number | 0 | |||
dyn_thread | Number | 1 | |||
dly_constraint_load | Number | 0 | |||
zip_level | Number | 0 | |||
ddl_cv | Number | 0 | |||
keep_bad_act | Number | 0 | |||
fill_lob_column | Number | 0 | |||
keep_seq_sync | Number | 0 | |||
keep_usr_pwd | Number | 0 | |||
convert_urp_of_key | Number | 0 | |||
ignore_foreign_key | Number | 0 | |||
gen_txn | Number | 0 | |||
run_time | String | 运行时间 | "1200:00-13:0040M,300:00-13:0040M" | ||
enable_truncate_frequence | String | truncate频率限制 0:关 1:开 | |||
error_handling | Object | ||||
irp | String | irpafterdel | |||
urp | String | toirp | |||
drp | String | ignore | |||
load_err_set | String | continue | |||
report_failed_dml | Number | 0 | |||
bw_settings | Object | ||||
bw_limit | String | ||||
table_space_map | Object | ||||
tgt_table_space | String | ||||
table_mapping_way | String | ptop | |||
table_path_map | Array | ||||
table_space_name | Array | ||||
full_sync_settings | Object | ||||
load_mode | String | direct | |||
ld_dir_opt | Number | 0 | |||
dump_thd | Number | 1 | |||
load_thd | Number | 1 | |||
try_split_part_table | Number | 1 | |||
clean_user_before_dump | Number | 0 | |||
existing_table | String | drop_to_recycle | |||
concurrent_table | String | [] | |||
sync_mode | Number | 0 | |||
start_scn | String | ||||
full_sync_custom_cfg | Array | 全局自定义配置 | |||
key | String | ||||
value | String | ||||
full_sync_obj_filter | Object | ||||
full_sync_obj_data | Array | ||||
inc_sync_ddl_filter | Object | ||||
inc_sync_ddl_data | Array | ||||
filter_table_settings | Object | ||||
exclude_table | String | [] | |||
etl_settings | Object | ||||
etl_table | Array | ||||
_ | String | 489d781db90cb |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | success |
同步规则 - 批量新建
SDK方法名:createBatchOceanRule;
URL
/ocean/rule/batch
Method
POST
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
start_rule_now | Number | 1 | |||
rule_name | String | 12321 | |||
tgt_type | String | ||||
db_list | Array | ||||
src_db_uuid | String | 2C4C2E77-774D-C604-9A32-5038D8E590C4 | |||
tgt_db_uuid | String | ||||
src_db_auth_uuid | String | ||||
tgt_db_auth_uuid | String | ||||
map_type | String | db | |||
db_user_map | String | ||||
table_map | String | ||||
dbmap_topic | String | ||||
row_map_mode | String | rowid | |||
sync_mode | Number | 1 | |||
start_scn | String | ||||
kafka_time_out | String | 120000 | |||
part_load_balance | String | by_table | |||
kafka_message_encoding | String | UTF-8 | |||
kafka | Object | ||||
binary_code | String | hex | |||
dml_track | Object | ||||
enable | Number | 0 | |||
urp | Number | 0 | |||
drp | Number | 0 | |||
tmcol | String | ||||
delcol | String | ||||
storage_settings | Object | ||||
src_max_mem | String | 512 | |||
src_max_disk | String | 5000 | |||
txn_max_mem | String | 10000 | |||
tf_max_size | String | 100 | |||
max_ld_mem | String | 512 | |||
tgt_extern_table | String | ||||
other_settings | Object | ||||
keep_dyn_data | Number | 0 | |||
dyn_thread | Number | 1 | |||
dly_constraint_load | Number | 0 | |||
zip_level | Number | 0 | |||
ddl_cv | Number | 0 | |||
keep_bad_act | Number | 0 | |||
fill_lob_column | Number | 0 | |||
keep_seq_sync | Number | 0 | |||
keep_usr_pwd | Number | 0 | |||
convert_urp_of_key | Number | 0 | |||
ignore_foreign_key | Number | 0 | |||
gen_txn | Number | 0 | |||
run_time | String | 运行时间 | "1200:00-13:0040M,300:00-13:0040M" | ||
enable_truncate_frequence | Number | truncate频率限制 0:关 1:开 | 0 | ||
error_handling | Object | ||||
irp | String | irpafterdel | |||
urp | String | toirp | |||
drp | String | ignore | |||
load_err_set | String | continue | |||
report_failed_dml | Number | 0 | |||
bw_settings | Object | ||||
bw_limit | String | ||||
table_space_map | Object | ||||
tgt_table_space | String | ||||
table_mapping_way | String | ptop | |||
table_path_map | Array | ||||
table_space_name | Array | ||||
full_sync_settings | Object | ||||
load_mode | String | direct | |||
ld_dir_opt | Number | 0 | |||
dump_thd | Number | 1 | |||
load_thd | Number | 1 | |||
try_split_part_table | Number | 1 | |||
clean_user_before_dump | Number | 0 | |||
existing_table | String | drop_to_recycle | |||
concurrent_table | String | [] | |||
sync_mode | Number | 0 | |||
start_scn | String | ||||
full_sync_obj_filter | Object | ||||
full_sync_obj_data | Array | ||||
inc_sync_ddl_filter | Object | ||||
inc_sync_ddl_data | Array | ||||
filter_table_settings | Object | ||||
exclude_table | String | [] | |||
etl_settings | Object | ||||
etl_table | Array | ||||
_ | String | 489d781db90cb |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | success |
同步规则 - 修改
SDK方法名:modifyOceanRule;
URL
/ocean/rule
Method
PUT
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
同步规则 - 获取单个
SDK方法名:describeOceanRule;
URL
/ocean/rule/:id
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | [0] 操作成功。 | |||
info_list | Array | ||||
rule_uuid | String | 2511627B-5306-EE10-E1D3-97CC89450D89 | |||
src_db_uuid | String | 2C4C2E77-774D-C604-9A32-5038D8E590C4 | |||
tgt_db_uuid | String | 953C47CB-3F6C-E72F-DF1C-31522468A566 | |||
rule_type | Number | 61 | |||
rule_name | String | 12321 | |||
user_uuid | String | 1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC | |||
node_uuid | String | ||||
tgt_type | String | db2 | |||
db_user_map | String | ||||
row_map_mode | String | rowid | |||
map_type | String | db | |||
table_map | String | ||||
dbmap_topic | String | ||||
sync_mode | String | 1 | |||
start_scn | String | 0 | |||
storage_settings | Object | ||||
src_max_mem | String | 512 | |||
src_max_disk | String | 5000 | |||
txn_max_mem | String | 10000 | |||
tf_max_size | String | 100 | |||
max_ld_mem | String | 512 | |||
tgt_extern_table | String | ||||
table_space_map | Object | ||||
tgt_table_space | String | ||||
table_mapping_way | String | ptop | |||
table_path_map | Array | ||||
table_space_name | Array | ||||
other_settings | Object | ||||
keep_dyn_data | Number | 0 | |||
dyn_thread | Number | 1 | |||
dly_constraint_load | Number | 0 | |||
zip_level | Number | 0 | |||
ddl_cv | Number | 0 | |||
keep_bad_act | Number | 0 | |||
fill_lob_column | Number | 0 | |||
keep_seq_sync | Number | 0 | |||
keep_usr_pwd | Number | 0 | |||
convert_urp_of_key | Number | 0 | |||
ignore_foreign_key | Number | 0 | |||
gen_txn | Number | 0 | |||
error_handling | Object | ||||
irp | String | irpafterdel | |||
urp | String | toirp | |||
drp | String | ignore | |||
load_err_set | String | continue | |||
report_failed_dml | Number | 0 | |||
bw_settings | Object | ||||
bw_limit | String | ||||
strate | Null | ||||
full_sync_settings | Object | ||||
load_mode | String | direct | |||
ld_dir_opt | Number | 0 | |||
dump_thd | Number | 1 | |||
load_thd | Number | 1 | |||
try_split_part_table | Number | 1 | |||
clean_user_before_dump | Number | 0 | |||
concurrent_table | String | [] | |||
existing_table | String | drop_to_recycle | |||
full_sync_obj_filter | Object | ||||
full_sync_obj_data | Array | ||||
inc_sync_ddl_filter | Object | ||||
inc_sync_ddl_data | Array | ||||
filter_table_settings | Object | ||||
exclude_table | String | [] | |||
etl_settings | Object | ||||
etl_table | Array | ||||
create_time | Number | 1601362592 | |||
start_rule_now | Number | 1 | |||
db_map_uuid | String | ||||
dml_track | Object | ||||
enable | Number | 0 | |||
urp | Number | 0 | |||
drp | Number | 0 | |||
tmcol | String | ||||
delcol | String | ||||
kafka_time_out | String | 120000 | |||
part_load_balance | String | by_table | |||
kafka_message_encoding | String | UTF-8 | |||
kafka | Object | ||||
binary_code | String | hex |
同步规则 - 删除
SDK方法名:deleteOceanRule;
URL
/ocean/rule
Method
DELETE
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
rule_uuids | Array | ||||
type | String | false_rule | |||
force | Number | 0 |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 1 | |||
message | String | [0] success | |||
success_list | Array | ||||
code | Number | 0 | |||
message | String | [0] success | |||
rule_uuid | String | 16CB63E1-13FA-FB32-EB49-D790682C9648 | |||
rule_name | String | task1 | |||
fail_list | Array | ||||
code | Number | -1 | |||
message | String | [-1] 找不到节点 | |||
rule_uuid | String | 16CB63E1-13FA-FB32-EB49-D790682C9647 | |||
rule_name | String | task2 |
同步规则 - 操作
SDK方法名: 继续:resumeOceanRule; 停止:stopOceanRule; 重启:restartOceanRule 开始日志解析:startAnalysisOceanRule; 停止日志解析:stopAnalysisOceanRule; 重新日志解析:resetAnalysisOceanRule; 复制:duplicateOceanRule
URL
/ocean/rule/operate
Method
POST
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
operate | String | resume | stop | restart | start_analysis(停止解析) | |
rule_uuid | String | ||||
scn | String |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | success |
同步规则 - 状态
SDK方法名:listSyncRulesStatus
URL
/ocean/rule/status
Method
GET
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
uuids | Array |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | Number | 200 | |||
msg | String | ||||
data | Object | ||||
code | Number | 0 | |||
message | String | [0] 操作成功。 | |||
has_false_rule | Boolean | 是否有残留规则 | false | ||
info_list | Array | 2 | |||
rule_uuid | String | 同步规则 uuid | ['6ECF19A1-3754-1490-C6A3-52AFB4D7F497', '6ECF19A1-3754-1490-C6A3-52AFB4D7F496'] | +1 | |
work_state | Object | 导出状态信息 | |||
status | String | ACTIVE_RULE_NORMAL : 正常 ACTIVE_RULE_ABNORMAL : 异常 ACTIVE_RULE_TRACK : 增量 ACTIVE_RULE_TRACK_WARNING : 增量 ACTIVE_RULE_PAUSE : 停止 ACTIVE_RULE_STOP : 停止 ACTIVE_RULE_DUMPDICT : 准备 ACTIVE_RULE_DUMP : 全量 ACTIVE_RULE_DONE : 完成 ACTIVE_RULE_FINISH : 完成 ACTIVE_RULE_ERROR : 错误 ACTIVE_RULE_INIT : 未启动 ACTIVE_RULE_FIX : 修复中 ACTIVE_RULE_UNKNOWN : 未知 ACTIVE_RULE_ONLINE : 在线 ACTIVE_RULE_WARN : 警告 ACTIVE_RULE_DOING : 在线 ACTIVE_RULE_ : 未知 ACTIVE_RULE_OFFLINE : 停止 ACTIVE_RULE_RUN : 运行 ACTIVE_RULE_WAIT : 准备 ACTIVE_REVERSE_FINISH : 完成 ACTIVE_REVERSE_ABNORMAL : 异常 ACTIVE_REVERSE_WARN : 警告 ACTIVE_REVERSE_UNKNOWN : 未知 ACTIVE_REVERSE_ : 未知 ACTIVE_REVERSE_FINISH : 完成 ACTIVE_REVERSE_ABNORMAL : 异常 ACTIVE_REVERSE_WARN : 警告 ACTIVE_REVERSE_UNKNOWN : 未知 ACTIVE_REVERSE_ : 未知 REVERSE_DOING : 在线 REVERSE_DONE : 完成 REVERSE_STOP : 停止 REVERSE_PAUSE : 暂停 ACTIVE_RULE_SCHEDULING : [调度中] ACTIVE_RULE_STOP_SCHEDUL : [停止调度] OBJ_FIX_DOING : 正在修复 OBJ_FIX_DONE : 修复完成 OBJ_FIX_ERROR : 修复错误 OBJ_FIX_UNKNOWN : 未知 OBJ_FIX_STOP : 停止修复 OBJ_FIX_ABNORMAL : 修复异常 OBJ_FIX_PAUSE : 停止 OBJ_FIX_OFFLINE : 离线 CMP_ABNORMAL : 比较异常 CMP_DOING : 正在比较 CMP_DONE : 比较完成 CMP_ERROR : 比较错误 CMP_UNKNOWN : 未知 CMP_PAUSE : 停止 CMP_STOP : 停止 CMP_WAIT : 等待中 CMP_OFFLINE : 离线 TAKEOVER_UNKNOWN : 未知 TAKEOVER_DOING : 正在接管 TAKEOVER_DONE : 接管完成 TAKEOVER_ERROR : 接管错误 TAKEOVER_STOP : 接管停止 TAKEOVER_ABNORMAL : 接管异常 TAKEOVER_OFFLINE : 离线 | ACTIVE_RULE_TRACK | ||
error_code | Number | -4018 | |||
progress | String | [98, 66] | +1 | ||
back_state | Object | 装载信息 | |||
status | String | 同上work_state | ACTIVE_RULE_PAUSE | ||
relay_state | Object | 中继节点的信息 | |||
status | String | 同上work_state | |||
error_code | String | ||||
track_state | Object | 解析状态信息 | |||
status | String | 同上work_state | ['ACTIVE_RULE_PAUSE', 'OFFLINE'] | +1 | |
src_state | Object | 此功能对应数据源的状态,领导要求暂时屏蔽此功能,可不看 | |||
status | String | ACTIVE_RULE_UNKNOWN | |||
dst_state | Object | 同src_state | |||
status | String | ACTIVE_RULE_UNKNOWN | |||
extract | String | 解析时间 | - | ||
load | String | 装载时间 | - | ||
delay | Number | 延迟 | 0 | ||
peak | Number | 峰值 | 0 | ||
has_new_err | Number | 对应日志报警 1:显示有新的日志 0:没有新日志产生 | 1 | ||
data_info | Object | 对应的悬浮框内的信息 | |||
dst | Object | 目标端 | |||
db_ip | Array | 目标端ip | ["192.168.12.199"] | ||
node_ip | String | 节点ip | 192.168.12.199 | ||
node_name | String | 名称 | test_c199 | ||
log_read_type | String | 日志读取方式 | file | ||
orcl | String | 服务名 | orcl | ||
src | Object | 数据源 | |||
db_ip | Array | 数据库ip | ["192.168.12.200"] | ||
node_ip | String | 节点ip | 192.168.12.200 | ||
node_name | String | 节点名 | test_c200 | ||
log_read_type | String | 读取方式 | file | ||
orcl | String | 服务名 | orcl | ||
stage | String | 对应原先功能总览->同步规则的功能,暂时弃用 | PAUSE | ||
state | Number | 对应原先功能总览->同步规则的功能,暂时弃用 | -4018 | ||
progress | Null | 对应原先功能总览->同步规则的功能,暂时弃用 | |||
scheduleState | String | ACTIVE_RULE_SCHEDULING:调度中 ACTIVE_RULE_STOP_SCHEDUL:停止调度 | ACTIVE_RULE_STOP_SCHEDUL |
同步规则 - 表修复
SDK方法名:createOceanTableFix
URL
/ocean/rule/table_fix
Method
POST
Request
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
rule_uuid | String | 修复规则uuid | |||
tab | String | 源端数据库uuid | [ "I2.table" ] |
Response
名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
---|---|---|---|---|---|
ret | String | 200 | |||
msg | String | success | |||
data | Object | ||||
code | String | 0 | |||
message | String |