qianBase同步

June 24, 2022About 13 min

qianBase同步

SDK类名:/active/QianBaseSync;

qianbase同步规则-列表

SDK方法名:listQianbaseRule

URL

/qianbase/rule

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
pageNumber1
limitNumber10
search_fieldString
search_valueString
group_uuidString
where_argsObject
  rule_uuidString

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
retNumber200
msgString
dataObject
  totalNumber5
  info_listArray2
    rule_uuidArray[
"6FBC9EB9-A10A-E226-9F2B-A77B3CF1D337",
"3BF809AF-4A2E-DD28-072E-530D33BAC189"
]
+1
    rule_nameArray["Ronal","Melissa"]+1
    src_db_uuidString
    tgt_db_uuidString
    tgt_typeStringkafka
    user_uuidString1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
    tgt_db_nameStringbei
    map_typeStringdatabase
    configObject
      start_rule_nowNumber1
      table_mapString
      full_syncNumber1
      incre_syncNumber1
      full_sync_modeString
      db_user_mapObject
      dbmap_topicString
      row_map_modeString
      kafka_time_outString
      part_load_balanceString
      kafka_message_encodingString
    src_db_nameString1111
    is_biz_adminNumber
    can_delNumber
    can_opNumber
    can_upNumber
  messageString
  codeNumber0

新建

SDK方法名:createQianbaseRule

URL

/qianbase/rule

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
rule_nameStringtest
src_db_uuidString7B1BE386-4CB1-86AA-D39D-B644C2EADD57
map_typeStringtable
configObject
  start_rule_nowNumber1
  db_setArray
    tgt_db_uuidStringCD52E44B-D25A-4CE3-126F-6F5A460731E4
    filter_typeNumber[1:filter_table,0:no_fileter]
    table_mapArray
      src_tableString
      dst_tableString
    custom_configArray
      keyString
      valueString
    tgt_typeString
  all_custom_configArray
    keyString
    valueString
  sync_contentArray
    sync_colString
  jointingObject字段拼接
    tableString
    opString操作
op类型定义
前辍 prefix 后辍 append 常量 const 拼接 join 加 add 减 sub 乘 multiply 除 divide
    contentString目标列+其他两行
  save_json_textString【目标类型为Kafka】保存为文件
  kafka_db_uuidStringkafka消息引擎
  conn_numNumber数据库最大连接数
  loaderNumber并发装载数
  schema_nameString同步的Schema名

Response

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

修改

SDK方法名:modifyQianbaseRule

URL

/qianbase/rule

Method

PUT

Request

名称类型必选简介Mock初始值Mock规则
rule_nameString
src_db_uuidString
tgt_db_uuidString
tgt_typeStringsqlserver
map_typeStringdb
configObject
  start_rule_nowNumber1
  table_mapArray
  full_syncNumber0
  incre_syncNumber
   full_sync_modeString1
  db_user_mapString
  dbmap_topicString
  row_map_modeString
  kafka_time_outString
  part_load_balanceString
  kafka_message_encodingString
  db_setArray
    tgt_db_uuidString
    filter_typeString
    tgt_typeString
    table_mapArray
      src_tableString
      dst_tableString
    custom_configArray
      keyString
      valueString
  all_custom_configArray
    keyString
    valueString
  sync_contentArray
    sync_colString
rule_uuidString

Response

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

删除

SDK方法名:deleteQianbaseRule

URL

/qianbase/rule

Method

DELETE

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageStringsuccess
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

qianbase规则-状态

SDK方法名:listQianbaseStatus

URL

/qianbase/rule/status

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  info_listArray2
    rule_uuidArray["6FBC9EB9-A10A-E226-9F2B-A77B3CF1D337","3BF809AF-4A2E-DD28-072E-530D33BAC189"]+1
    export_stateObject
      statusStringACTIVE_RULE_DUMP
      progressString66
    load_stateObject
      statusStringACTIVE_RULE_ABNORMAL
      error_codeNumber-4014
    track_stateObject
      statusStringACTIVE_RULE_STOP
      error_codeNumber-4014
    peakNumber峰值210
    delayNumber延迟2110
    extractString解析时间2019-06-25 11:26:19
    loadString2019-06-25 11:26:19
    stageStringpause: 停止
dump: 全量
track:增量
done:完成
offline:离线
done
    stateNumber错误码:0 正常
非0 错误码
0
    progressString进度8080
    scheduleStateStringACTIVE_RULE_SCHEDULING:调度中
ACTIVE_RULE_STOP_SCHEDUL:停止调度

启/停/重新同步/继续

SDK方法名:{operate}QianbaseRules

URL

/qianbase/rule/operate

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
operateStringresume | stop (暂时只保留这两个)

暂时弃(
restartstop_schedule 停止调度
start_schedule 启动调度

start_analysis 开始解析
stop_analysis 停止解析
reset_analysis 重置解析)
uuidsArray
scnString

Response

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

qianbase日志

SDK方法名:listQianbaseRuleLog

URL

/qianbase/rule/log

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
offsetNumber0
limitNumber10
date_startString
date_endString
typeNumber1
module_typeNumber1
query_typeNumber1
rule_uuidString@guid

Response

名称类型必选简介Mock初始值Mock规则
msgString
dataObject
  codeNumber0
  messageStringDelete success
  info_listArray
    create_timeString2019-08-09 17:29:43
    detailStringFull Sync done, elapsed time: 24 sec'
    flagNumber1
    log_levelString2
    log_typeString装载
    uuidString@uuid
retNumber200

qianbase 表比较

URL

/========qianbase表比较======

Method

GET

Request

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

Response

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

qianbase获取单个信息

SDK方法名:describeQianbaseRules

URL

/qianbase/rule/:uuid([A-F0-9-]+)

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  messageString
  codeNumber0
  qianbase_ruleObject
    rule_nameStringpostgres->kafka
    src_db_uuidString1111
    tgt_db_uuidString2222
    tgt_typeStringkafka
    map_typeStringdatabase
    configObject
      start_rule_nowNumber1
      table_mapString[{"src_user":"111","src_table":"222","dst_user":"333","dst_table":"444","column":[]}]
      full_syncNumber1
      incre_syncNumber1
      full_sync_modeStringlogic
      db_user_mapString{"111":"1112"}
      dbmap_topicString111
      row_map_modeStringrowid
      kafka_time_outString1200000
      part_load_balanceStringby_table
      kafka_message_encodingStringUTF-8
    rule_uuidString@uuid

qianbase表比较 - 新建

SDK方法名:createQbTbCmp

URL

/qianbase/tb_cmp

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
tb_cmp_nameStringctt->ctt
src_db_uuidString4CA773F4-36E3-A091-122C-ACDFB2112C21
tgt_db_uuidString40405FD3-DB86-DC8A-81C9-C137B6FDECE5
cmp_typeStringuser,table,db
db_user_mapString{"CTT":"CTT"}
filter_tableArray[用户.表名]
db_tb_mapString表映射
dump_thdNumber抽取线程数
rule_uuidString@guid
policesString策略"0|00:00
policy_typeString策略类型;periodic(周期) ,one_time 一次性任务 immediate 立刻执行one_time
concurrent_tableArray并发表["hh.ww"]
try_split_part_tableNumber尝试并发设置 0:否 1:是0
one_timeString策略的开始时间,如果不是一次性任务为空值2019-05-27 16:07:08
repairNumber0
fix_relatedNumber0
configObject
  tab_cmp_filterArray
    userStringtest
    tableStringtest
    conditionStringselect * from xxx

Response

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

qianbase状态接口

SDK方法名:listQbTbCmpStatus;状态接口

URL

/qianbase/tb_cmp/status

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString
  info_listArray2
    extractString解析时间2019-06-25 11:26:19
    cmp_uuidString@guid
    peakString峰值100
    dst_stateObject目标端
      statusString目标端状态OFFLINE
    delayString延迟10
    loadString装载时间2019-06-23 20:23:18
    work_stateObject同步规则对应导出,其他规则对应源机
      statusString状态ABNORMAL
      error_codeString错误码4017
    src_stateObject源端
      statusStringONLINE
    back_stateObject
      statusStringDUMP
      progressString80
    relay_stateObject装载
      statusStringTRACK
    track_stateObject解析
      statusStringUNKNOWN

qianbase表比较 - 获取单个

SDK方法名:describeQbTbCmp

URL

/qianbase/tb_cmp/:uuid([A-F0-9-]+)

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
uuidString表比较规则的uuid@guid

Response

名称类型必选简介Mock初始值Mock规则
src_db_uuidString4CA773F4-36E3-A091-122C-ACDFB2112C21
retNumber200
msgString
dataObject
  codeNumber0
  messageString
  qianbase_tb_cmpObject
    table_cmp_nameStringctt->ctt
    src_db_uuidString4CA773F4-36E3-A091-122C-ACDFB2112C21
    tgt_db_uuidString40405FD3-DB86-DC8A-81C9-C137B6FDECE5
    cmp_typeStringuser
    db_user_mapString{"CTT":"CTT"}
    filter_table_settingsString[用户.表名]
    db_tb_mapString表映射
    dump_thdNumber1
    rule_uuidString5DA7469c-b5d5-Bd53-5ADB-7Eee6D31e60B
    policiesString1|00:091,2,3*1
    policy_typeStringperiodic
    concurrentTabArray["hh.ww"]
    try_split_part_tableNumber0
    one_timeString2019-05-27 16:07:08

qianbase表比较 - 删除

SDK方法名:deleteQbTbCmp

URL

/qianbase/tb_cmp

Method

DELETE

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  messageString
  codeNumber0
  success_listArray
    codeString
    messageString
    tb_cmp_nameString
    tb_cmp_uuidString
  fail_listArray
    codeString
    messageString
    tb_cmp_nameString
    tb_cmp_uuidString

qianbase表比较 - 列表

SDK方法名:listQbTbCmp

URL

/qianbase/tb_cmp

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
pageNumber1
limitNumber10
search_fieldString
search_valueString

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  totalNumber20
  info_listArray
    create_timeString1593511163
    tb_cmp_nameStringname321
    src_db_uuidString4CA773F4-36E3-A091-122C-ACDFB2112C21
    tgt_db_uuidString40405FD3-DB86-DC8A-81C9-C137B6FDECE5
    user_uuidString1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
    tb_cmp_uuidStringC038DE5A-CDB2-F26D-FA5F-93E3FF266A87
    tgt_db_nameStringbei
    usernameStringadmin
    can_opNumber1
    can_upNumber1
    can_delNumber1
    is_biz_adminNumber1
    src_db_nameStringyuan
    policy_typeStringimmediate; one_time;periodicimmediate
  messageString

qianbase 历史结果

SDK方法名:listQbTbCmpResultTimeList

URL

/qianbase/tb_cmp/result_time_list

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString
  time_listArray16
    show_timeString2019-07-05 17:35:13
    summaryObject
      totalNumber1192
      use_timeNumber844
      diffNumber130
    timeString2019-07-05_17-35-13
  totalNumber20

qianbase表比较-操作

SDK方法名:

停止:stopQbTbCmp;

重启:restartQbTbCmp;

URL

/qianbase/tb_cmp/operate

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
tb_cmp_uuidsArray@guid
operateStringcmp_stop | cmp_restart

Response

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

qianbase表比较-比较结果的删除

SDK方法名:describeQbTbCmpResuluTimeList;查看结果删除

URL

/qianbase/tb_cmp/result_time_list

Method

DELETE

Request

名称类型必选简介Mock初始值Mock规则
uuidString
time_listArray@guid

Response

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

qianbase表比较-比较任务结果

SDK方法名:describeQbTbCmpResult

URL

/qianbase/tb_cmp/result

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
pageNumber1
limitNumber10
search_fieldString
search_valueString
uuidString@guid
start_timeString对应的时间

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  messageString
  codeNumber0
  head_infoObject
    totalNumber100
    errNumber10
    endString2019-10-10 12:00:00
    startString2019-10-10 10:00:00
    use_timeString3600
  result_infoObject
    rowsArray10
      src_userStringuser
      src_table_nameStringAnna Martin
      srcStringCynthia Gonzalez
      dstStringRobert Johnson
    totalNumber30

qianbase表比较-错误信息

SDK方法名:describeQbTbCmpErrorMsg;错误信息

URL

/qianbase/tb_cmp/error_msg

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
offsetNumber1
limitNumber10
search_fieldString
search_valueString
uuidString@guid
start_timeString
nameString
ownerString所属者admin

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  messageString
  codeNumber0
  result_infoObject
    rowsArray10
      src_rowString@name
      dst_rowString@name
    totalNumber2000

qianbase表比较-比较结果

SDK方法名:describeQbTbCmpCmpResult

URL

/qianbase/tb_cmp/cmp_result

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString
  summaryObject
    totalNumber1192
    use_timeNumber844
    diffNumber130
Last update: 9/26/2022, 4:07:53 PM
Contributors: ganl