离线同步(8.3版本支持多源端)

August 1, 2024About 15 min

离线同步(8.3版本支持多源端)

示例接口

示例接口描述

URL

/example/1670469216802

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函数属性示例function() {
return this.number
}
arrayArray数组属性示例1-10
  fooNumber数组元素示例1+1
  barString数组元素示例1-10
itemsArray自定义数组元素示例[1, true, 'hello', /\w{10}/]
objectObject对象属性示例
  fooNumber对象属性示例1+1
  barString对象属性示例1-10
placeholderString占位符示例@title

离线同步 - 列表

SDK方法名:listOfflineRule

URL

/offline_rule

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
limitString
pageString
search_fieldString
search_valueString
group_uuidString
where_argsArray
  rule_uuidString@guid
  statusStringdump

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[0] 操作成功。
  info_listArray
    tgt_db_nameStringkfk73
    search_ipString["1.1.1.1"]
    src_db_nameStringmysql1
    src_typeStringmysql
    src_build_inNull
    src_type_uuidNull
    src_mapping_type_nameNull
    tgt_typeStringkafka
    tgt_build_inNull
    tgt_type_uuidNull
    tgt_mapping_type_nameNull
    src_node_ipString192.168.10.73
    src_node_nameStringwb_73
    tgt_node_nameStringwb_73
    usernameStringadmin
    user_uuidString1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
    idNumber18
    rule_nameString1
    rule_uuidString22C51942-A1D5-470D-AD3E-1277759079F9
    node_uuidString
    src_db_uuidStringEE22F24E-F605-4A9F-8559-47E823935F05
    src_db_auth_uuidStringE44E8075-A61D-4419-85E4-89B86030B074
    tgt_db_uuidString899FAA7A-C471-45DE-A6EF-A22AF125DD57
    tgt_db_auth_uuidString
    tgt_file_pathString
    charsetNull
    map_typeStringuser
    separatorNull
    create_timeNumber1699517073
    table_mapNull
    db_user_mapObject
      1String11
    advanced_settingsObject
      dump_thdNumber1
      load_thdNumber1
    etl_settingsObject
      etl_tableArray
    full_sync_custom_cfgArray2
      enableNumber0
      keyStringsource.to.target.processor.plugin
      valueArray["{"classname":"org.example.dataconvert.ExampleSourceToTargetProcessorPlugin","config":{"organizationCode":[{"col":"TEST_VALUE","orgmap":{"0.32":"0.6000000"}}]}}","{"classname":"org.example.dataconvert.ExampleSourceToTargetProcessorPlugin","config":{"organizationCode":[{"col":"TEST_VALUE","orgmap":{"0.32":"0.2000000"}}]}}"]+1
    policiesNull
    formatObject
      datetagString
      charsetStringUTF-8
      delimiterString,
      quoteString`
      headerString
      force_quoteNumber0
      byte_encodeStringnone
      date_formatStringyyyyMMdd
      time_formatStringHHmmss
      nullString\N
      escapeString\
      datetime_formatStringyyyyMMddHHmmss
      timestamp_formatStringyyyyMMddHHmmss.SSS
    virtual_tableArray
    policy_typeStringone_time
    existing_tableStringtruncate
    advanced_table_mapArray
    configObject
      one_taskStringimmediate
    one_timeString
    src_node_uuidNull
    src_file_pathString
    stateObject
      work_stateObject
        statusStringACTIVE_RULE_ABNORMAL
        error_codeNumber-4016
      back_stateObject
        statusStringACTIVE_RULE_ABNORMAL
        error_codeNumber-4016
      track_stateObject
        statusStringACTIVE_RULE_STOP
        error_codeNumber-4016
      scheduleStateNull
      start_timeNumber1699517073
      timeNumber1715247815
      stageStringACTIVE_RULE_ERROR
    statusNull
    maintenanceNumber0
    commentNull
    is_biz_adminNumber1
    can_delNumber1
    can_opNumber1
    can_upNumber1
    can_viewNumber1
  totalNumber1

离线同步 - 新建

SDK方法名:createActiveOfflineRule

URL

/offline_rule

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
rule_nameString
map_typeString映射类型
整库:db,表:table,
用户schema:user
源端为文件:file
src_db_uuidString源端数据库uuid
src_db_auth_uuidString源端数据库认证用户uuid
tgt_db_uuidString备端数据库uuid
tgt_db_auth_uuidString备端数据库认证用户uuid
src_node_uuidString源端类型csv时,机器节点uuid
node_uuidString备端类型csv时,机器节点uuid
src_typeString源端类型,文本文件:dump_format_file
tgt_typeString备端类型,文本文件:dump_format_file
src_file_pathString源端文件路径
tgt_file_pathString目标文件路径
file_mapArray仅源端为文件时
  src_file_pathString文件路径
  src_file_nameString文件名
  tgt_topicString备端topic
etl_settingsObjectETL配置
  etl_tableArray
    oprTypeString
    tableString
    userString
    processString
    addInfoString
advanced_table_mapArray拓展表映射内容
  srcObject源端
    userString用户
    tabString
  tgtObject(暂不适用)
    userString
    tabString
  columnObject
    sync_by_defaultNumber同步其余列 0关1开
    column_map_listArray
      operateString操作类型,
新增:a,
修改:m,
删除:d,
不变:u
a
      expressionString源端表达式col1+col2
      column_nameString备端列名newCol
      column_typeString备端列 数据类型int
      src_column_nameString源端列名
table_mapArray表映射内容
  src_db_uuidString源端数据库uuid
  tgt_db_uuidString备端数据库uuid
  src_tableString
  tgt_tableString
  src_dbString
  dst_dbString
  columnArray
    src_columnString
    dst_columnString
db_user_mapArray用户映射内容
  srcObject
    userString
    dbUuidString数据库uuid
  tgtObject
    userString
    dbUuidString数据库uuid
advanced_settingsObject
  dump_thdNumber
  load_thdNumber
  exclude_table_by_featuresObject表示排除掉对应表
    PKBoolean主键
    UKBoolean唯一约束
    FKBoolean外键
    INDEXBoolean索引
full_sync_custom_cfgArray全局自定义配置
  keyString是否启用,0:关,1:开
  valueString
  enableString是否启动
policiesArraycron数组
policy_typeString
formatObject文件类型基本设置
  headerNumber输出列名,0关1开
  delimiterString分隔符
  quoteString列引号值
  force_quoteNumber列引号值策略
0:不使用
1:列值包含特殊字符时使用
2:始终使用
  escapeString转义符
  nullStringNULL值转换
  date_formatStringdate类型格式
  datetime_formatStringdatetime类型格式
  timestamp_formatStringtimestamp类型格式
  time_formatStringtime类型格式
  byte_encodeStringbyte数组编码格式
none:原始数组
zero: 原始数组,0x00替换为'\0'即二进制"5c30
base64:base64
hex:hex
  encodeString字符集
  outpathString备端文件路径
  datatagString统计列
  line_breakString(源端为文件类型时)文件换行符
  delimiterAfterLastColumnBoolean是否最后一列有分隔符
  delimiterUtf8CodeBoolean列分隔符是否是utf-8编码
  linesTerminatedByUtf8CodeBoolean行分隔符是否是utf-8编码
full_map_switchNumber整库映射开关,0关1开
virtual_tableArray指定SQL查询导出设置
  dbUuidString数据库uuid
  userString备端用户
  tabString备端表名
  sqlStringsql语句
  srcuserString源端用户
  srctabString源端表名
  metasqlStringmetaSQL
  metaUsingColDefsBoolean元信息
  colDefsArray列定义配置
    nameString列名
    typenameString数据类型
    lengthString长度
    precisionString精度
    scaleStringSCALE
    jdbcTypeNumberJDBC类型
    nullableNumber为空,0:否,1:是
  splitInfoObject拆分(只能一条,没配置的时候发null)
    tableNameObject
      schemaString源端用户
      nameString源端表
    aliasNameString虚拟映射别名
    colNameString拆分列名
maintenanceNumber维护模式,0:关,1:开
commentString备注
start_rule_nowNumber立即启动,0:关,1:开
src_db_uuidsArray源端数据库uuid组
src_db_type_uuidsArray源端数据库类型uuid组
src_db_auth_infoArray
  db_uuidString
  auth_uuidString

Response

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

离线同步 - 修改

SDK方法名:updateActiveOfflineRule

URL

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

Method

PUT

Request

名称类型必选简介Mock初始值Mock规则
rule_nameString
map_typeString映射类型
整库:db,表:table,
用户schema:user
文件映射:file
src_db_uuidString源端数据库uuid
src_db_auth_uuidString源端数据库认证用户uuid
tgt_db_uuidString备端数据库uuid
tgt_db_auth_uuidString备端数据库认证用户uuid
node_uuidString备端类型csv时,下发机器节点uuid
src_typeString
tgt_typeString备端类型
tgt_file_pathString目标文件路径
file_mapArray仅源端为文件时5
  src_file_pathString文件路径@path
  src_file_nameString文件名@first
  tgt_topicString备端topic@last
advanced_table_mapArray拓展表映射内容
  srcObject源端
    userString用户
    tabString
  tgtObject(暂不适用)
    userString
    tabString
  columnObject
    sync_by_defaultNumber同步其余列 0关1开
    column_map_listArray
      operateString操作类型,
新增:a,
修改:m,
删除:d,
不变:u
a
      expressionString源端表达式col1+col2
      column_nameString备端列名newCol
      column_typeString备端列 数据类型int
      src_column_nameString源端列名
table_mapArray表映射内容
  src_tableString
  tgt_tableString
  src_dbString
  dst_dbString
  columnArray
    src_columnString
    dst_columnString
db_user_mapArray用户映射内容
  srcObject
    userString
  tgtObject
    userString
advanced_settingsObject
  dump_thdNumber
  load_thdNumber
etl_settingsObjectETL配置
  etl_tableArray
    oprTypeString
    tableString
    userString
    processString
    addInfoString
full_sync_custom_cfgArray全局自定义配置
  keyString
  valueString
policiesArraycron数组
policy_typeString
formatObject文件类型基本设置
  headerNumber输出列名,0关1开
  delimiterString分隔符
  quoteString列引号值
  force_quoteNumber列引号值策略
0:不使用
1:列值包含特殊字符时使用
2:始终使用
  escapeString转义符
  nullStringNULL值转换
  date_formatStringdate类型格式
  datetime_formatStringdatetime类型格式
  timestamp_formatStringtimestamp类型格式
  time_formatStringtime类型格式
  byte_encodeStringbyte数组编码格式
none:原始数组
zero: 原始数组,0x00替换为'\0'即二进制"5c30
base64:base64
hex:hex
  encodeString字符集
  outpathString备端文件路径
  datatagString统计列
  line_breakString(源端为文件类型时)文件换行符
full_map_switchNumber整库映射开关,0关1开
virtual_tableArray虚拟表列表
  userString用户
  tabString表名
  sqlStringsql语句

Response

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

离线同步 - 状态

SDK方法名:listOfflineRuleStatus

URL

/offline_rule/status

Method

POST

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retString0
msgString
dataArray
  info_listArray
    rule_uuidString@guid
    rule_nameString@first
    work_stateObject
      statusString
      error_codeString
    back_stateObject
      statusString
      error_codeString
    statusString
    error_codeString

离线同步规则组 - 状态

SDK方法名:listOfflineRuleGroupStatus

URL

/offline_rule_group/status

Method

POST

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retString0
msgString
dataArray
  info_listArray
    uuidString@guid
    nameString@first
    statusStringwait 等待
waitTrigger 等待触发
running 执行中
completed 完成
stop 停止
    rule_statObject
      successString成功
      failString失败
      runningString执行中
      waitScheduleString等待调度
    rulesString规则数量
    startString开始时间
    resumeString继续时间
    endString结束时间
    progressNumber进度(只有执行中需要展示)

离线同步 - 删除

SDK方法名:deleteOfflineRule

URL

/offline_rule

Method

DELETE

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retString0
msgString
dataObject
  codeString
  messageString
  success_listArray5
    codeString0
    messageString
    rule_uuidString
    rule_nameString
  fail_listArray5
    codeString-1
    messageString
    rule_uuidString
    rule_nameString
  all_listArray10
    codeString@pick(1,0)
    messageString
    rule_nameString
    rule_uuidString

离线同步 - 操作

SDK方法名:operateOfflineRule

URL

/offline_rule/operate

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
uuidsArray规则uuids
operateStringresume 继续
stop 停止
restart 重新同步
stop_schedule 停止定时
resume_schedule 继续定时

Response

名称类型必选简介Mock初始值Mock规则
retString200
msgString
dataObject
  codeString@pick(-1,0)
  messageString

离线同步 - 字符集

SDK方法名:getOfflineRuleCharset

URL

/offline_rule/charset

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString
  charsetArray["GBK",
"UTF-8",
"UTF-16BE",
"UTF-16LE"]

离线同步 - 单条获取

SDK方法名:describeOfflineRule

URL

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

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
rule_uuidString@guid
rule_nameString@name
src_typeString@pick("file", "mysql")
tgt_typeString@pick("file", "mysql")
file_mapArray
  src_file_pathString@sentence
  src_file_nameString@first
  tgt_topicString@last
map_typeStringfile

离线同步规则组 - 单条获取

SDK方法名:describeOfflineRule

URL

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

Method

GET

Request

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

Response

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

离线同步规则组 - 修改

SDK方法名:describeOfflineRule

URL

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

Method

PUT

Request

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

Response

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

离线同步规则组 - 列表

URL

/offline_rule_group

Method

GET

Request

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

Response

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

离线同步规则组 - 新建

URL

/offline_rule_group

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
group_nameString规则组名
priorityNumber组优先级,1-999
trigger_conditionString
rule_listArray
  rule_uuidString规则uuid@guid
  priorityNumber组内优先级,1-9999
start_rule_nowNumber立即启动,0:关,1:开

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageString[1010001009] 名称重复

离线同步规则组 - 删除

URL

/offline_rule_group

Method

DELETE

Request

名称类型必选简介Mock初始值Mock规则
group_uuidsArray规则组UUID数组
priorityNumber组内优先级,1-9999
forceNumber强制删除,0:是,1:否

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber1055554016
  messageString[1055554016] 节点离线,通常为iahelper程序异常
  fail_listArray4
    codeNumber1055554016
    messageString[1055554016] 节点离线,通常为iahelper程序异常
    rule_uuidArray["B0CEBD39-99CB-419A-A5FD-2474648059DF","8639CD15-ECA6-4822-939E-0EB919176DC3","AF648851-6710-4512-9F51-6A096356B369","27BD6753-8AA8-4BBB-B643-3305E9A4BF32"]+1
    rule_nameArray["test","testaaa","test","polar73tok"]+1
  all_listArray4
    codeNumber1055554016
    messageString[1055554016] 节点离线,通常为iahelper程序异常
    rule_uuidArray["B0CEBD39-99CB-419A-A5FD-2474648059DF","8639CD15-ECA6-4822-939E-0EB919176DC3","AF648851-6710-4512-9F51-6A096356B369","27BD6753-8AA8-4BBB-B643-3305E9A4BF32"]+1
    rule_nameArray["test","testaaa","test","polar73tok"]+1

离线同步规则组 - 操作

URL

/offline_rule_group/operate

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
group_uuidsArray规则组UUID数组
operateString操作,启动:resume,停止:stop
priorityNumber组内优先级,1-9999

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber1055554016
  messageString[1055554016] 节点离线,通常为iahelper程序异常
  fail_listArray4
    codeNumber1055554016
    messageString[1055554016] 节点离线,通常为iahelper程序异常
    rule_uuidArray["B0CEBD39-99CB-419A-A5FD-2474648059DF","8639CD15-ECA6-4822-939E-0EB919176DC3","AF648851-6710-4512-9F51-6A096356B369","27BD6753-8AA8-4BBB-B643-3305E9A4BF32"]+1
    rule_nameArray["test","testaaa","test","polar73tok"]+1
  all_listArray4
    codeNumber1055554016
    messageString[1055554016] 节点离线,通常为iahelper程序异常
    rule_uuidArray["B0CEBD39-99CB-419A-A5FD-2474648059DF","8639CD15-ECA6-4822-939E-0EB919176DC3","AF648851-6710-4512-9F51-6A096356B369","27BD6753-8AA8-4BBB-B643-3305E9A4BF32"]+1
    rule_nameArray["test","testaaa","test","polar73tok"]+1

离线同步 - 修改维护模式

SDK方法名:switchOfflineRuleMaintenance

URL

/offline_rule/maintenance

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
maintenance_switchNumber维护模式开关,0:关,1:开
uuidString规则uuid

Response

名称类型必选简介Mock初始值Mock规则
retNumber0
msgString
dataObject
  codeNumber
  messageString
Last update: 8/1/2024, 2:00:50 PM
Contributors: ganl