Oceanbase

November 18, 2022About 10 min

Oceanbase

SDK类名:/active/Oceanbase;

示例接口

示例接口描述

URL

/example/1635239913612

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

同步规则列表

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"
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方法名: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
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"
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方法名:{operate}OceanRule;

URL

/ocean/rule/operate

Method

POST

Request

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

Response

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

日志

SDK方法名:listOceanRuleLog;

URL

/ocean/rule/log

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
offsetNumber0
limitNumber10
date_startString
date_endString
typeNumber1
module_typeNumber1
query_typeNumber1
rule_uuidString3FCdeF6f-9CC5-B9Ee-C4F2-8e19eb118528

Response

名称类型必选简介Mock初始值Mock规则
Last update: 11/18/2022, 3:56:21 PM
Contributors: ganl