Kafka同步

June 24, 2022About 18 min

Kafka同步

SDK类名:/active/Hetero

示例接口

示例接口描述

URL

/example/1571888297732

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
fooString请求属性示例@ctitle

Response

名称类型必选简介Mock初始值Mock规则
stringString字符串属性示例1-10
numberNumber数字属性示例11-100
booleanBoolean布尔属性示例true1-2
regexpRegExp正则属性示例/[a-z][A-Z][0-9]/
functionFunction函数属性示例() => Math.random()
arrayArray数组属性示例1-10
  fooNumber数组元素示例1+1
  barString数组元素示例1-10
itemsArray自定义数组元素示例[1, true, 'hello', /\w{10}/]
objectObject对象属性示例
  fooNumber对象属性示例1+1
  barString对象属性示例1-10
placeholderString占位符示例@title

===============分割线==================

URL

/example

Method

GET

Request

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

Response

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

异构-新建(暂弃用)

SDK 方法名:createHeteroRule

URL

/hetero/rule

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
nameString
kfk_verString
dst_nodeString备端节点
conn_typeString连接方式 zookepper broker
hostStringzookeeper主机
portStringzookeeper 端口
brokerString
tabmapObject
consumer_thread_numNumber2
actload_thread_numNumber4

Response

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

异构-删除(暂弃用)

SDK 方法名:deleteHeteroRule

URL

/hetero

Method

DELETE

Request

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

Response

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

异构-获取列表(暂弃用)

SDK 方法名:listHeteroRule

URL

/hetero/rule

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  messageString
  codeNumber0
  info_listArray
    nameString测试kafka集群
    dst_nodeString1
    conn_typeString2.0
    brokerString192.168.28.90:58080
    kfk_verString3.0
    uuidString@uuid
    is_biz_adminNumber1
    can_opNumber1
    can_upNumber1
    can_delNumber1
    broker_idString1

异构-查看topic(暂弃用)

SDK 方法名:createHeteroTopic

URL

/hetero/topic

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  messageString
  codeNumber0
  info_listArray
    topicListArray"topic1","topic2","topic3""topic1","topic2","topic3"

异构-查看消费者(暂弃用)

SDK 方法名:createConsumer

URL

/hetero/view_consumer

Method

POST

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  messageString
  codeNumber0
  info_listArray
    consumerString111
    topicString222
    partitionString333
    current_offestString444
    logend_offsetString5555
  totalNumber10

异构-消费

SDK方法名:consumer

URL

/hetero/consumer

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
topicString
offsetString
linesString
show_fowardNumber

Response

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

---------消费规则-----

URL

/消费规则

Method

GET

Request

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

Response

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

异构-消费-新建

SDK方法名:createConsumerRule

URL

/hetero/consumer/rule

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
src_db_uuidString源库uuidB5CED857-275C-77C4-0561-887F7C890FF2
nameString规则名称@name
tgt_typeString目标端类型oracle
init_offsetArray指定偏移位置
  topicStringtest
  offsetString1
  partitionString1
topicString(源端topic,kafka->kafka)test1
dst_topicStringkafka->kafka 备端topictopic1
tgt_db_uuidString备库uuid1C5F3C4B-7333-9518-7349-9712BC9ED664
tabmapArray表映射
  src_tableStringsrc_t
  dst_tableStringdst_t
  kudu_partition_configObject
    hashSettingBooleanfalse
    hash_definitionsArray
    rangSettingBooleanfalse
    range_definitionObject
      range_columnsString
      range_partitionsArray
  columnArray字段映射
    dst_columnString
    src_columnString
init_offset_typeStringlatest,seekearlist
consumer_thread_numNumber消费线程数2
actload_thread_numNumber装载线程数4
kudu_partition_configArray备端类型kudu 对应的设置
impala_connectedBoolean连接impalafalse
configObject
  goldendb_configObject
    machine_numberNumber1
    distribute_typeStringhash,duplicate
  insert_date_configObject备端kudu 扩展字段设置 设置插入行日期
    enableBooleanfalse
    column_nameStringETL_INSERT_DATE
  primary_key_configObject唯一性主键
    primary_key_configStringprimaryKey
    use_insert_dateBooleanfalse
    use_rowidBooleanfalse
    use_source_table_keyBooleanfalse
  target_userString目标端连接用户oracle
  target_db_nameString目标端数据库名@name
  db_nameString数据库名称(mysql)@name
  kerberos_certifyBoolean
  dmltrackObject
    enableBooleanfalse
    tmcolString1
  target_user_mapString目标端用户映射{}
  machine_numNumber1
  part_configArrayhive目标表指定分区
2
    part_indexNumber默认 0
分区字段顺序, 0 第一级, 0 第二级
@pick([0, 1])
    part_col_nameString分区字段名,如hdfs_parnull
    part_typeString无分区:ALL
日分区:DAY ,写入目标值格式yyyyMMdd
月分区:MONTH,写入目标值格式yyyyMM
年分区:YEAR,写入目标值格式yyyy
源表字段值:SOURCE, 写入目标无需转换
ALL
    part_from_col_nameString来源源表字段,无分区null,其他分区必填null
    part_from_date_formatString源表日期类型,
如果源表是date/timestamp/datetime等,此format不起作用
如果源表是 varchar/string的日期,此format值用于按part_type转换,如:yyyy-MM-dd hh:mm:ss ,写入目标表时,part_type=DAY,则写入2021-06-23
null
  existing_tableString
  error_dealString错误处理
继续:continue
停止:stop
该项已屏蔽
  binary_codeString取值 hex , base64
  load_err_setString装载错误处理方式,
旧接口兼容保留项,建议使用error_handling.load_err_set
  error_handlingObject
    load_err_setString装载错误处理方式
continue 继续装载
stopld:停止装载
stoptabld:停止此表装载
continue
  hdfs_configObject
    authStringnone :无认证
kerberos: kerberos
    principalString
    keytabString
    kbsuserString

Response

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

异构-消费-修改

SDK方法名:modifyConsumerRule

URL

/hetero/consumer/rule

Method

PUT

Request

名称类型必选简介Mock初始值Mock规则
nameStringm-k-hive
src_db_uuidString86A56D69-72DE-AA2F-1C7E-C0A843F1D9EA
tgt_typeStringhive
init_offsetArray
  topicStringtest4
  offsetString18684815
  partitionString0
modifyBooleantrue
dst_topicStringdst_topic
tgt_db_uuidStringoracle 类型时773AE76A-7DB6-E465-2508-3919C875916E
init_offset_typeStringlatest,seekseek
tabmapArray
  src_tableStringsrc-t6
  dst_tableStringdst-t6
consumer_thread_numNumber41
actload_thread_numNumber41
uuidString356FF271-0D32-C35A-75A2-C68AD3A70FB3
kudu_partition_configArray
  hashSettingBoolean
  hash_definitionsArray
  rangSettingBooleanfalse
  rang_definitionArray
    range_columsString
    range_partitionsNumber
impala_connectedBooleanfalse
configObject
  goldendb_configObject
    machine_numberNumber
    distribute_typeString
  insert_date_configObject
    enableBoolean
    column_nameString
  primary_key_configObject
    primary_key_configString
    use_insert_dateBoolean
    use_rowidBoolean
    use_source_table_keyBoolean
  target_userStringoracle
  target_db_nameString@name
  db_nameString@name
  kerberos_certifyBoolean
  dmltrackObject
    enableBooleanfalse
    tmcolString
  part_configStringnone
  target_user_mapString{}
  machine_numNumber
  existing_tableString表覆盖策略
  error_dealString
  load_err_setString装载错误处理方式,
旧接口兼容保留项,建议使用error_handling.load_err_set
  binary_codeString取值 hex , base64
  error_handlingObject错误处理大类
    load_err_setString装载错误处理方式
continue 继续装载
stopld:停止装载
stoptabld:停止此表装载
start_rule_nowNumber1
topicStringtest4
user_uuidString1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC

Response

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

异构-消费-删除

SDK方法名:deleteConsumerRules

URL

/hetero/consumer/rule

Method

DELETE

Request

名称类型必选简介Mock初始值Mock规则
uuidsArray规则uuid["@guid","@guid"]
forceBoolean强制删除true

Response

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

异构-消费-状态

SDK方法名:listConsumerStatus

URL

/hetero/consumer/status

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString
  info_listArray5
    uuidStringC038DE5A-CDB2-F26D-FA5F-93E3FF266A87
    runObject
      statusStringACTIVE_RULE_PAUSE(停止)
ACTIVE_RULE_STOP(异常停止)
ACTIVE_RULE_DUMP(全量)
ACTIVE_RULE_TRACK(增量)
ACTIVE_RULE_DONE(完成)
ACTIVE_RULE_OFFLINE(离线)
ACTIVE_RULE_DOING
      progressString80
      error_codeString说明:不等于0时才有此值,其他情况不存在
    stageStringpause: 停止
stop:停止(异常停止)
dump: 全量
track:增量
done:完成
offline:离线
stop
    stateString0:正常
非0:错误
-4017
    progressString进度
    delayNumber1.1
    peakNumber2.2
    extractString@date @time
    loadString@date @time

异构-消费-操作

SDK方法名:{operate}ConsumerRule stop | resume

URL

/hetero/consumer/operate

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
operateStringstop 停止
resume 继续
resume
uuidString@guid

Response

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

异构-消费-获取规则列表

SDK方法名:listConsumerRules

URL

/hetero/consumer/viewtype

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
search_fieldStringtgt_type
limitNumber
pageNumber
search_valueString
where_argsObject
  uuidString

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  messageString
  codeNumber0
  info_listArray5
    nameString@name
    dst_nodeString1
    conn_typeString1
    uuidStringC038DE5A-CDB2-F26D-FA5F-93E3FF266A87
    tgt_typeArray['kafka', 'sqlserver', 'hbase', 'postgres', 'oracle']+1
    taripString172.168.42.114
    portString58080
    kfk_verString2.0
    dst_topicString
    dst_bootstrap_serverString
    bootstrap_serverString
    is_biz_adminNumber1
    can_opNumber1
    can_upNumber1
    can_delNumber1
    topicString
    data_infoObject
      srcObject
        db_ipArray['192.167.111.111']
        log_read_typeStringfile
        orclStringorcl
        node_nameStringsrc1
        node_ipString192.167.111.111
      dstObject
        db_ipArray['192.167.111.112']
        log_read_typeStringfile
        orclStringorcl
        node_nameStringdst1
        node_ipString192.167.111.112
    dst_broker_serverArray
      ipString199.199.222.222
      portString213
    src_broker_serverArray
      ipString199.199.222.222
      portString123
    src_db_nameString12344
    tgt_db_nameString5513
  totalNumber12

异构-消费-获取单条规则

SDK方法名:describeConsumerRules

URL

/hetero/consumer/:uuid([A-F0-9-]+)

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
uuidString75DF8EA3-6480-4137-451B-731F04F368AF

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageStringsuccess
  info_listObject
    nameString@name
    tgt_typeStringoracle
    src_db_uuidString111
    tgt_db_uuidString111eee
    topicString111,222,333
    dst_topicString321,222,333
    init_offset_typeStringseek
    init_offsetArray
      topicString111
      offsetString222
      partitionString333
    actload_thread_numString4
    consumer_thread_numString2
    tabmapArray2
      src_tableStringSRC
      dst_tableStringDST
    kudu_partition_configArray2
      table_nameStringDST
      hash_definitionsArray
        hash_columnsStringRCOL1,RCOL2
        hash_bucket_numString16
      range_definitionObject
        range_columnsStringRCOL1,RCOL2
        range_partitionsArray
          lowerString20200101,100
          upperString20200201,200
      hashSettingBooleantrue
      rangeSettingBooleantrue
    configObject
      insert_date_configObject
        enableBooleantrue
        column_nameStringETL_INSERT_DATE1
      primary_key_configObject
        use_source_table_keyBooleanfalse
        use_rowidBooleantrue
        use_insert_dateBooleantrue
      goldendb_configObject
        machine_numberNumber
        distribute_typeString"hash","duplicate"hash

--------拓扑管理-------

URL

/拓扑管理

Method

GET

Request

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

Response

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

异构-拓扑-新建

SDK方法名:createHeteroGraph

URL

/hetero/graph

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
graph_nameString拓扑图名称
is_parentString
is_ruleString
consume_ruleArray消费规则所需的参数
  idString
  rule_nameString规则名称
  src_typeString源端类型
  src_uuidString源端uuid
  dst_typeString备端类型
  rule_numberNumber1
  rule_statusString规则状态
  rule_trafficString
  is_parentBoolean0
  is_ruleBoolean0
  src_nameString源端名
  dst_nameString备端名
  dst_uuidString

Response

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

异构-拓扑-添加

SDK方法名:addHeteroGraph

URL

/hetero/graph/add

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
graph_uuidString拓扑规则
rule_numberString规则号
src_typeStringoracle,kafka,mysql
rule_uuidString

Response

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

异构-拓扑-获取列表

SDK方法名:listHeteroGraph

URL

/hetero/graph/list

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
messageStringsuccess
retNumber200
msgString
dataObject
  codeNumber0
  info_listArray2
    idNumber1
    graph_nameStringtopo-o2k-kafka-oracle-test2
    graph_uuidString1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC-Graph@uuid
    is_parentBooleantrue
    is_ruleBoolean0
    consume_ruleArray4
      idNumber11+1
      rule_nameStringo2k-kafka-oracle-test2
      rule_uuidString3D7dFcd9-C176-d9ee-4FFB-f22bbd554944
      src_typeArray['oracle', 'kafka', 'mysql', 'postgres']+1
      src_uuidString3D7dFcd9-C176-d9ee-4FFB-f22bbd554925
      dst_typeArray['kafka', 'mysql', 'postgres', 'sqlserver']+1
      rule_numberNumber0+1
      rule_statusStringstop
      rule_trafficString31455
      is_parentBooleanfalse
      is_ruleArray[true,false,true,true]+1
      src_nameString源端名字@name
      dst_nameString备端名字@name
      dst_uuidStringC038DE5A-CDB2-F26D-FA5F-93E3FF266A87
    can_opNumber1
    can_upNumber1
    can_delNumber0
    is_biz_adminNumber1
  messageString

异构-拓扑-运行拓扑

SDK方法名:runHeteroGraph

URL

/hetero/graph/run

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
graphsArray
graph_uuidString
rule_uuidsArray
  uuidString
  src_typeStringoracle,kafka,mysql

Response

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

异构-拓扑-停止拓扑

SDK方法名:stopHeteroGraph

URL

/hetero/graph/stop

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
graphsArray
  graph_uuidString
  rule_uuidsArray
    uuidString
    src_typeStringoracle,mysql,kafka

Response

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

异构-拓扑-状态

SDK方法名:listGraphStatus

URL

/hetero/graph/status

Method

GET

Request

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

Response

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

异构-拓扑-删除拓扑

SDK方法名:deleteHeteroGraph

URL

/hetero/graph

Method

DELETE

Request

名称类型必选简介Mock初始值Mock规则
graph_uuidsArray
  graph_uuidString@uuid
  rule_uuidsArray
    uuidString@uuid
    is_ruleString1
    rule_numberString4
    src_typeStringoracle
is_wholeString1

Response

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

异构-拓扑-拓扑详情

SDK方法名:descriptGraphDetail

URL

/hetero/graph/detail

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
pageNumber1
limitNumber10
start_timeString
end_timeString
graph_uuidString

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  messageString
  codeNumber0
  info_listArray2
    2019-10-11Array2
      uuidString1c7DBA2b-A5AA-F1A6-1587-d5844db5BdAF
      nameString@name
      numberNumber1-100
  totalNumber1

---------拓扑图管理------

URL

/拓扑图管理

Method

GET

Request

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

Response

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

异构-拓扑图-获取拓扑图

SDK方法名:listGraph

URL

/hetero/graph/graph

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  messageString
  codeNumber0
  info_listArray
    srcObject
      nodeObject
        nameStringoracle-kafka-199-266
        stateStringok
        statusStringnode_online/node_error/node_ignorenode_online
        typeStringoracle
      kafkaObject
        statusStringkafka_normalkafka_normal
        srcidString
        trafficString10004956
        typeStringkafka
        nameStringkafka-oracle
        scntimeString06-25 11:26:19
    relayObject
      nodeArray
        nameString300kkkkkkkkkkkkkkkkkkkkkkkkkkkkkkk
        stateStringok
        statusStringdb_abnormal/db_ignore/db_normaldb_abnormal
        trafficStringN/A
        typeStringkafka
        scntimeString06-25 11:26:58N/A
    dstObject
      nodeArray2
        nameStringkafka-oralce-6000123
        stateStringok
        statusStringnode_online
        trafficString100564
        typeStringoracle
        scntimeString06-25 11:26:1906-25 11:26:19
    summaryObject
      nameString199-200
      stateString1/00
      stageStringpause
      uuidString@guid
      statusStringrect_normalrect_error
      extractString2019-06-25 11:26:10
Last update: 11/18/2022, 3:56:21 PM
Contributors: ganl