Oceanbase同步

February 26, 2024About 12 min

Oceanbase同步

SDK类名:/active/Oceanbase;

同步规则 - 列表

SDK方法名:listOceanRule;

URL

/ocean/rule

Method

GET

Request

名称类型必选简介Mock初始值Mock规则

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  info_listArray
    src_db_nameStringdb2_1
    tgt_db_nameStringdb2_2
    usernameStringadmin
    user_uuidString1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
    rule_uuidString2511627B-5306-EE10-E1D3-97CC89450D89
    src_db_uuidString2C4C2E77-774D-C604-9A32-5038D8E590C4
    tgt_db_uuidString953C47CB-3F6C-E72F-DF1C-31522468A566
    rule_typeNumber61
    rule_nameString12321
    node_uuidString
    tgt_typeStringkafka
    db_user_mapString
    row_map_modeStringrowid
    map_typeStringdb
    table_mapString
    dbmap_topicString
    sync_modeString1
    start_scnString0
    storage_settingsObject
      src_max_memString512
      src_max_diskString5000
      txn_max_memString10000
      tf_max_sizeString100
      max_ld_memString512
      tgt_extern_tableString
    table_space_mapObject
      tgt_table_spaceString
      table_mapping_wayStringptop
      table_path_mapArray
      table_space_nameArray
    other_settingsObject
      keep_dyn_dataNumber0
      dyn_threadNumber1
      dly_constraint_loadNumber0
      zip_levelNumber0
      ddl_cvNumber0
      keep_bad_actNumber0
      fill_lob_columnNumber0
      keep_seq_syncNumber0
      keep_usr_pwdNumber0
      convert_urp_of_keyNumber0
      ignore_foreign_keyNumber0
      gen_txnNumber0
    error_handlingObject
      irpStringirpafterdel
      urpStringtoirp
      drpStringignore
      load_err_setStringcontinue
      report_failed_dmlNumber0
    bw_settingsObject
      bw_limitString
    strateNull
    full_sync_settingsObject
      load_modeStringdirect
      ld_dir_optNumber0
      dump_thdNumber1
      load_thdNumber1
      try_split_part_tableNumber1
      clean_user_before_dumpNumber0
      existing_tableStringdrop_to_recycle
      concurrent_tableString[]
    full_sync_obj_filterObject
      full_sync_obj_dataArray
    inc_sync_ddl_filterObject
      inc_sync_ddl_dataArray
    filter_table_settingsObject
      exclude_tableString[]
    etl_settingsObject
      etl_tableArray
    create_timeNumber1601362592
    start_rule_nowNumber1
    db_map_uuidString
    dml_trackObject
      enableNumber0
      urpNumber0
      drpNumber0
      tmcolString
      delcolString
    kafka_time_outString120000
    part_load_balanceStringby_table
    kafka_message_encodingStringUTF-8
    kafkaObject
      binary_codeStringhex
    is_biz_adminNumber1
    can_delNumber1
    can_opNumber1
    can_upNumber1
  totalNumber2

同步规则 - 新建

SDK方法名:createOceanRule;

URL

/ocean/rule

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
start_rule_nowNumber1
rule_nameString12321
src_db_uuidString2C4C2E77-774D-C604-9A32-5038D8E590C4
tgt_typeStringdb2
tgt_db_uuidString953C47CB-3F6C-E72F-DF1C-31522468A566
map_typeStringdb
db_user_mapString
table_mapString
dbmap_topicString
row_map_modeStringrowid
sync_modeNumber1
start_scnString
kafka_time_outString120000
part_load_balanceStringby_table
kafka_message_encodingStringUTF-8
kafkaObject
  binary_codeStringhex
dml_trackObject
  enableNumber0
  urpNumber0
  drpNumber0
  tmcolString
  delcolString
storage_settingsObject
  src_max_memString512
  src_max_diskString5000
  txn_max_memString10000
  tf_max_sizeString100
  max_ld_memString512
  tgt_extern_tableString
other_settingsObject
  keep_dyn_dataNumber0
  dyn_threadNumber1
  dly_constraint_loadNumber0
  zip_levelNumber0
  ddl_cvNumber0
  keep_bad_actNumber0
  fill_lob_columnNumber0
  keep_seq_syncNumber0
  keep_usr_pwdNumber0
  convert_urp_of_keyNumber0
  ignore_foreign_keyNumber0
  gen_txnNumber0
  run_timeString运行时间"1200:00-13:0040M,300:00-13:0040M"
  enable_truncate_frequenceStringtruncate频率限制 0:关 1:开
error_handlingObject
  irpStringirpafterdel
  urpStringtoirp
  drpStringignore
  load_err_setStringcontinue
  report_failed_dmlNumber0
bw_settingsObject
  bw_limitString
table_space_mapObject
  tgt_table_spaceString
  table_mapping_wayStringptop
  table_path_mapArray
  table_space_nameArray
full_sync_settingsObject
  load_modeStringdirect
  ld_dir_optNumber0
  dump_thdNumber1
  load_thdNumber1
  try_split_part_tableNumber1
  clean_user_before_dumpNumber0
  existing_tableStringdrop_to_recycle
  concurrent_tableString[]
  sync_modeNumber0
  start_scnString
  full_sync_custom_cfgArray全局自定义配置
    keyString
    valueString
full_sync_obj_filterObject
  full_sync_obj_dataArray
inc_sync_ddl_filterObject
  inc_sync_ddl_dataArray
filter_table_settingsObject
  exclude_tableString[]
etl_settingsObject
  etl_tableArray
_String489d781db90cb

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageStringsuccess

同步规则 - 批量新建

SDK方法名:createBatchOceanRule;

URL

/ocean/rule/batch

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
start_rule_nowNumber1
rule_nameString12321
tgt_typeString
db_listArray
  src_db_uuidString2C4C2E77-774D-C604-9A32-5038D8E590C4
  tgt_db_uuidString
  src_db_auth_uuidString
  tgt_db_auth_uuidString
map_typeStringdb
db_user_mapString
table_mapString
dbmap_topicString
row_map_modeStringrowid
sync_modeNumber1
start_scnString
kafka_time_outString120000
part_load_balanceStringby_table
kafka_message_encodingStringUTF-8
kafkaObject
  binary_codeStringhex
dml_trackObject
  enableNumber0
  urpNumber0
  drpNumber0
  tmcolString
  delcolString
storage_settingsObject
  src_max_memString512
  src_max_diskString5000
  txn_max_memString10000
  tf_max_sizeString100
  max_ld_memString512
  tgt_extern_tableString
other_settingsObject
  keep_dyn_dataNumber0
  dyn_threadNumber1
  dly_constraint_loadNumber0
  zip_levelNumber0
  ddl_cvNumber0
  keep_bad_actNumber0
  fill_lob_columnNumber0
  keep_seq_syncNumber0
  keep_usr_pwdNumber0
  convert_urp_of_keyNumber0
  ignore_foreign_keyNumber0
  gen_txnNumber0
  run_timeString运行时间"1200:00-13:0040M,300:00-13:0040M"
  enable_truncate_frequenceNumbertruncate频率限制 0:关 1:开0
error_handlingObject
  irpStringirpafterdel
  urpStringtoirp
  drpStringignore
  load_err_setStringcontinue
  report_failed_dmlNumber0
bw_settingsObject
  bw_limitString
table_space_mapObject
  tgt_table_spaceString
  table_mapping_wayStringptop
  table_path_mapArray
  table_space_nameArray
full_sync_settingsObject
  load_modeStringdirect
  ld_dir_optNumber0
  dump_thdNumber1
  load_thdNumber1
  try_split_part_tableNumber1
  clean_user_before_dumpNumber0
  existing_tableStringdrop_to_recycle
  concurrent_tableString[]
  sync_modeNumber0
  start_scnString
full_sync_obj_filterObject
  full_sync_obj_dataArray
inc_sync_ddl_filterObject
  inc_sync_ddl_dataArray
filter_table_settingsObject
  exclude_tableString[]
etl_settingsObject
  etl_tableArray
_String489d781db90cb

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageStringsuccess

同步规则 - 修改

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规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  info_listArray
    rule_uuidString2511627B-5306-EE10-E1D3-97CC89450D89
    src_db_uuidString2C4C2E77-774D-C604-9A32-5038D8E590C4
    tgt_db_uuidString953C47CB-3F6C-E72F-DF1C-31522468A566
    rule_typeNumber61
    rule_nameString12321
    user_uuidString1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
    node_uuidString
    tgt_typeStringdb2
    db_user_mapString
    row_map_modeStringrowid
    map_typeStringdb
    table_mapString
    dbmap_topicString
    sync_modeString1
    start_scnString0
    storage_settingsObject
      src_max_memString512
      src_max_diskString5000
      txn_max_memString10000
      tf_max_sizeString100
      max_ld_memString512
      tgt_extern_tableString
    table_space_mapObject
      tgt_table_spaceString
      table_mapping_wayStringptop
      table_path_mapArray
      table_space_nameArray
    other_settingsObject
      keep_dyn_dataNumber0
      dyn_threadNumber1
      dly_constraint_loadNumber0
      zip_levelNumber0
      ddl_cvNumber0
      keep_bad_actNumber0
      fill_lob_columnNumber0
      keep_seq_syncNumber0
      keep_usr_pwdNumber0
      convert_urp_of_keyNumber0
      ignore_foreign_keyNumber0
      gen_txnNumber0
    error_handlingObject
      irpStringirpafterdel
      urpStringtoirp
      drpStringignore
      load_err_setStringcontinue
      report_failed_dmlNumber0
    bw_settingsObject
      bw_limitString
    strateNull
    full_sync_settingsObject
      load_modeStringdirect
      ld_dir_optNumber0
      dump_thdNumber1
      load_thdNumber1
      try_split_part_tableNumber1
      clean_user_before_dumpNumber0
      concurrent_tableString[]
      existing_tableStringdrop_to_recycle
    full_sync_obj_filterObject
      full_sync_obj_dataArray
    inc_sync_ddl_filterObject
      inc_sync_ddl_dataArray
    filter_table_settingsObject
      exclude_tableString[]
    etl_settingsObject
      etl_tableArray
    create_timeNumber1601362592
    start_rule_nowNumber1
    db_map_uuidString
    dml_trackObject
      enableNumber0
      urpNumber0
      drpNumber0
      tmcolString
      delcolString
    kafka_time_outString120000
    part_load_balanceStringby_table
    kafka_message_encodingStringUTF-8
    kafkaObject
      binary_codeStringhex

同步规则 - 删除

SDK方法名:deleteOceanRule;

URL

/ocean/rule

Method

DELETE

Request

名称类型必选简介Mock初始值Mock规则
rule_uuidsArray
typeStringfalse_rule
forceNumber0

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber1
  messageString[0] success
  success_listArray
    codeNumber0
    messageString[0] success
    rule_uuidString16CB63E1-13FA-FB32-EB49-D790682C9648
    rule_nameStringtask1
  fail_listArray
    codeNumber-1
    messageString[-1] 找不到节点
    rule_uuidString16CB63E1-13FA-FB32-EB49-D790682C9647
    rule_nameStringtask2

同步规则 - 操作

SDK方法名: 继续:resumeOceanRule; 停止:stopOceanRule; 重启:restartOceanRule 开始日志解析:startAnalysisOceanRule; 停止日志解析:stopAnalysisOceanRule; 重新日志解析:resetAnalysisOceanRule; 复制:duplicateOceanRule

URL

/ocean/rule/operate

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
operateStringresume | stoprestartstart_analysis(停止解析)
rule_uuidString
scnString

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageStringsuccess

同步规则 - 状态

SDK方法名:listSyncRulesStatus

URL

/ocean/rule/status

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
uuidsArray

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  has_false_ruleBoolean是否有残留规则false
  info_listArray2
    rule_uuidString同步规则 uuid['6ECF19A1-3754-1490-C6A3-52AFB4D7F497', '6ECF19A1-3754-1490-C6A3-52AFB4D7F496']+1
    work_stateObject导出状态信息
      statusStringACTIVE_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_codeNumber-4018
      progressString[98, 66]+1
    back_stateObject装载信息
      statusString同上work_stateACTIVE_RULE_PAUSE
    relay_stateObject中继节点的信息
      statusString同上work_state
      error_codeString
    track_stateObject解析状态信息
      statusString同上work_state['ACTIVE_RULE_PAUSE', 'OFFLINE']+1
    src_stateObject此功能对应数据源的状态,领导要求暂时屏蔽此功能,可不看
      statusStringACTIVE_RULE_UNKNOWN
    dst_stateObject同src_state
      statusStringACTIVE_RULE_UNKNOWN
    extractString解析时间-
    loadString装载时间-
    delayNumber延迟0
    peakNumber峰值0
    has_new_errNumber对应日志报警 1:显示有新的日志
0:没有新日志产生
1
    data_infoObject对应的悬浮框内的信息
      dstObject目标端
        db_ipArray目标端ip["192.168.12.199"]
        node_ipString节点ip192.168.12.199
        node_nameString名称test_c199
        log_read_typeString日志读取方式file
        orclString服务名orcl
      srcObject数据源
        db_ipArray数据库ip["192.168.12.200"]
        node_ipString节点ip192.168.12.200
        node_nameString节点名test_c200
        log_read_typeString读取方式file
        orclString服务名orcl
    stageString对应原先功能总览->同步规则的功能,暂时弃用PAUSE
    stateNumber对应原先功能总览->同步规则的功能,暂时弃用-4018
    progressNull对应原先功能总览->同步规则的功能,暂时弃用
    scheduleStateStringACTIVE_RULE_SCHEDULING:调度中
ACTIVE_RULE_STOP_SCHEDUL:停止调度
ACTIVE_RULE_STOP_SCHEDUL

同步规则 - 表修复

SDK方法名:createOceanTableFix

URL

/ocean/rule/table_fix

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
rule_uuidString修复规则uuid
tabString源端数据库uuid[
"I2.table"
]

Response

名称类型必选简介Mock初始值Mock规则
retString200
msgStringsuccess
dataObject
  codeString0
  messageString
Last update: 2/26/2024, 5:49:44 PM
Contributors: ganl