Oceanbase

oceanbase

示例接口

示例接口描述

URL

//example/1635239913612

Method

GET

Request

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

Response

名称	类型	必选	初始值	简介	Mock规则
string	String		★	字符串属性示例	1-10
number	Number		1	数字属性示例	1-100
boolean	Boolean		true	布尔属性示例	1-2
regexp	RegExp		/[a-z][A-Z][0-9]/	正则属性示例
function	Function		() => Math.random()	函数属性示例
array	Array			数组属性示例	1-10
foo	Number		1	数组元素示例	+1
bar	String		★	数组元素示例	1-10
items	Array		[1, true, 'hello', /\w{10}/]	自定义数组元素示例
object	Object			对象属性示例
foo	Number		1	对象属性示例	+1
bar	String		★	对象属性示例	1-10
placeholder	String		@title	占位符示例

同步规则列表

SDK方法名：listOceanRule;

URL

//ocean/rule

Method

GET

Request

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

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number		200
msg	String
data	Object
code	Number		0
message	String		[0] 操作成功。
info_list	Array
src_db_name	String		db2_1
tgt_db_name	String		db2_2
username	String		admin
user_uuid	String		1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
rule_uuid	String		2511627B-5306-EE10-E1D3-97CC89450D89
src_db_uuid	String		2C4C2E77-774D-C604-9A32-5038D8E590C4
tgt_db_uuid	String		953C47CB-3F6C-E72F-DF1C-31522468A566
rule_type	Number		61
rule_name	String		12321
node_uuid	String
tgt_type	String		kafka
db_user_map	String
row_map_mode	String		rowid
map_type	String		db
table_map	String
dbmap_topic	String
sync_mode	String		1
start_scn	String		0
storage_settings	Object
src_max_mem	String		512
src_max_disk	String		5000
txn_max_mem	String		10000
tf_max_size	String		100
max_ld_mem	String		512
tgt_extern_table	String
table_space_map	Object
tgt_table_space	String
table_mapping_way	String		ptop
table_path_map	Array
table_space_name	Array
other_settings	Object
keep_dyn_data	Number		0
dyn_thread	Number		1
dly_constraint_load	Number		0
zip_level	Number		0
ddl_cv	Number		0
keep_bad_act	Number		0
fill_lob_column	Number		0
keep_seq_sync	Number		0
keep_usr_pwd	Number		0
convert_urp_of_key	Number		0
ignore_foreign_key	Number		0
gen_txn	Number		0
error_handling	Object
irp	String		irpafterdel
urp	String		toirp
drp	String		ignore
load_err_set	String		continue
report_failed_dml	Number		0
bw_settings	Object
bw_limit	String
strate	Null
full_sync_settings	Object
load_mode	String		direct
ld_dir_opt	Number		0
dump_thd	Number		1
load_thd	Number		1
try_split_part_table	Number		1
clean_user_before_dump	Number		0
existing_table	String		drop_to_recycle
concurrent_table	String		[]
full_sync_obj_filter	Object
full_sync_obj_data	Array
inc_sync_ddl_filter	Object
inc_sync_ddl_data	Array
filter_table_settings	Object
exclude_table	String		[]
etl_settings	Object
etl_table	Array
create_time	Number		1601362592
start_rule_now	Number		1
db_map_uuid	String
dml_track	Object
enable	Number		0
urp	Number		0
drp	Number		0
tmcol	String
delcol	String
kafka_time_out	String		120000
part_load_balance	String		by_table
kafka_message_encoding	String		UTF-8
kafka	Object
binary_code	String		hex
is_biz_admin	Number		1
can_del	Number		1
can_op	Number		1
can_up	Number		1
total	Number		2

新建规则

SDK方法名：createOceanRule;

URL

//ocean/rule

Method

POST

Request

名称	类型	必选	初始值	简介	Mock规则
start_rule_now	Number		1
rule_name	String		12321
src_db_uuid	String		2C4C2E77-774D-C604-9A32-5038D8E590C4
tgt_type	String		db2
tgt_db_uuid	String		953C47CB-3F6C-E72F-DF1C-31522468A566
map_type	String		db
db_user_map	String
table_map	String
dbmap_topic	String
row_map_mode	String		rowid
sync_mode	Number		1
start_scn	String
kafka_time_out	String		120000
part_load_balance	String		by_table
kafka_message_encoding	String		UTF-8
kafka	Object
binary_code	String		hex
dml_track	Object
enable	Number		0
urp	Number		0
drp	Number		0
tmcol	String
delcol	String
storage_settings	Object
src_max_mem	String		512
src_max_disk	String		5000
txn_max_mem	String		10000
tf_max_size	String		100
max_ld_mem	String		512
tgt_extern_table	String
other_settings	Object
keep_dyn_data	Number		0
dyn_thread	Number		1
dly_constraint_load	Number		0
zip_level	Number		0
ddl_cv	Number		0
keep_bad_act	Number		0
fill_lob_column	Number		0
keep_seq_sync	Number		0
keep_usr_pwd	Number		0
convert_urp_of_key	Number		0
ignore_foreign_key	Number		0
gen_txn	Number		0
error_handling	Object
irp	String		irpafterdel
urp	String		toirp
drp	String		ignore
load_err_set	String		continue
report_failed_dml	Number		0
bw_settings	Object
bw_limit	String
table_space_map	Object
tgt_table_space	String
table_mapping_way	String		ptop
table_path_map	Array
table_space_name	Array
full_sync_settings	Object
load_mode	String		direct
ld_dir_opt	Number		0
dump_thd	Number		1
load_thd	Number		1
try_split_part_table	Number		1
clean_user_before_dump	Number		0
existing_table	String		drop_to_recycle
concurrent_table	String		[]
full_sync_obj_filter	Object
full_sync_obj_data	Array
inc_sync_ddl_filter	Object
inc_sync_ddl_data	Array
filter_table_settings	Object
exclude_table	String		[]
etl_settings	Object
etl_table	Array
_	String		489d781db90cb

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number		200
msg	String
data	Object
code	Number		0
message	String		success

修改规则

SDK方法名：modifyOceanRule;

URL

//ocean/rule

Method

PUT

Request

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

Response

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

单条规则

SDK方法名：describeOceanRule;

URL

//ocean/rule/:id

Method

GET

Request

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

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number		200
msg	String
data	Object
code	Number		0
message	String		[0] 操作成功。
info_list	Array
rule_uuid	String		2511627B-5306-EE10-E1D3-97CC89450D89
src_db_uuid	String		2C4C2E77-774D-C604-9A32-5038D8E590C4
tgt_db_uuid	String		953C47CB-3F6C-E72F-DF1C-31522468A566
rule_type	Number		61
rule_name	String		12321
user_uuid	String		1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
node_uuid	String
tgt_type	String		db2
db_user_map	String
row_map_mode	String		rowid
map_type	String		db
table_map	String
dbmap_topic	String
sync_mode	String		1
start_scn	String		0
storage_settings	Object
src_max_mem	String		512
src_max_disk	String		5000
txn_max_mem	String		10000
tf_max_size	String		100
max_ld_mem	String		512
tgt_extern_table	String
table_space_map	Object
tgt_table_space	String
table_mapping_way	String		ptop
table_path_map	Array
table_space_name	Array
other_settings	Object
keep_dyn_data	Number		0
dyn_thread	Number		1
dly_constraint_load	Number		0
zip_level	Number		0
ddl_cv	Number		0
keep_bad_act	Number		0
fill_lob_column	Number		0
keep_seq_sync	Number		0
keep_usr_pwd	Number		0
convert_urp_of_key	Number		0
ignore_foreign_key	Number		0
gen_txn	Number		0
error_handling	Object
irp	String		irpafterdel
urp	String		toirp
drp	String		ignore
load_err_set	String		continue
report_failed_dml	Number		0
bw_settings	Object
bw_limit	String
strate	Null
full_sync_settings	Object
load_mode	String		direct
ld_dir_opt	Number		0
dump_thd	Number		1
load_thd	Number		1
try_split_part_table	Number		1
clean_user_before_dump	Number		0
concurrent_table	String		[]
existing_table	String		drop_to_recycle
full_sync_obj_filter	Object
full_sync_obj_data	Array
inc_sync_ddl_filter	Object
inc_sync_ddl_data	Array
filter_table_settings	Object
exclude_table	String		[]
etl_settings	Object
etl_table	Array
create_time	Number		1601362592
start_rule_now	Number		1
db_map_uuid	String
dml_track	Object
enable	Number		0
urp	Number		0
drp	Number		0
tmcol	String
delcol	String
kafka_time_out	String		120000
part_load_balance	String		by_table
kafka_message_encoding	String		UTF-8
kafka	Object
binary_code	String		hex

删除规则

SDK方法名：deleteOceanRule;

URL

//ocean/rule

Method

DELETE

Request

名称	类型	必选	初始值	简介	Mock规则
rule_uuids	Array
type	String			false_rule
force	Number		0

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number		200
msg	String
data	Object
code	Number		1
message	String		[0] success
success_list	Array
code	Number		0
message	String		[0] success
rule_uuid	String		16CB63E1-13FA-FB32-EB49-D790682C9648
rule_name	String		task1
fail_list	Array
code	Number		-1
message	String		[-1] 找不到节点
rule_uuid	String		16CB63E1-13FA-FB32-EB49-D790682C9647
rule_name	String		task2

操作规则

SDK方法名：{operate}OceanRule;

URL

//ocean/rule/operate

Method

POST

Request

名称	类型	必选	初始值	简介	Mock规则
operate	String			resume | stop	restart
rule_uuid	String
scn	String

Response

名称	类型	必选	初始值	简介	Mock规则
ret	Number		200
msg	String
data	Object
code	Number		0
message	String		success

日志

SDK方法名：listOceanRuleLog;

URL

//ocean/rule/log

Method

POST

Request

名称	类型	必选	初始值	简介	Mock规则
offset	Number		0
limit	Number		10
date_start	String
date_end	String
type	Number		1
module_type	Number		1
query_type	Number		1
rule_uuid	String		3FCdeF6f-9CC5-B9Ee-C4F2-8e19eb118528

Response

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