离线同步

SDK类名：/active/OfflineRule

示例接口

示例接口描述

URL

/example/1670469216802

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	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		函数属性示例	function() { return this.number }
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方法名：listOfflineRule

URL

/offline_rule

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
limit	String
page	String
search_field	String
search_value	String
group_uuid	String
where_args	Array
rule_uuid	String

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String
info_list	Array				10
rule_uuid	String			@guid
rule_name	String			@first
src_db_uuid	String			@guid
src_db_name	String			@first
tgt_db_uuid	String			@guid
tgt_db_name	String			@first
src_db_type	String			oracle
tgt_db_type	String			csv
map_type	String			db
user_name	String			@first
user_uuid	String			@guid
can_del	String			1
cal_op	String			1
create_time	String
node_name	String
total	Number			10

离线同步 - 新建

SDK方法名：createActiveOfflineRule

URL

/offline_rule

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rule_name	String
map_type	String		映射类型 整库：db，表：table, 用户schema：user 源端为文件：file
src_db_uuid	String		源端数据库uuid
src_db_auth_uuid	String		源端数据库认证用户uuid
tgt_db_uuid	String		备端数据库uuid
tgt_db_auth_uuid	String		备端数据库认证用户uuid
src_node_uuid	String		源端类型csv时，机器节点uuid
node_uuid	String		备端类型csv时，机器节点uuid
src_type	String		源端类型，文本文件：dump_format_file
tgt_type	String		备端类型，文本文件：dump_format_file
src_file_path	String		源端文件路径
tgt_file_path	String		目标文件路径
file_map	Array		仅源端为文件时
src_file_path	String		文件路径
src_file_name	String		文件名
tgt_topic	String		备端topic
etl_settings	Object		ETL配置
etl_table	Array
oprType	String
table	String
user	String
process	String
addInfo	String
advanced_table_map	Array		拓展表映射内容
src	Object		源端
user	String		用户
tab	String		表
tgt	Object		（暂不适用）
user	String
tab	String
column	Object
sync_by_default	Number		同步其余列 0关1开
column_map_list	Array
operate	String		操作类型， 新增：a， 修改：m， 删除：d， 不变：u	a
expression	String		源端表达式	col1+col2
column_name	String		备端列名	newCol
column_type	String		备端列 数据类型	int
src_column_name	String		源端列名
table_map	Array		表映射内容
src_table	String
tgt_table	String
src_db	String
dst_db	String
column	Array
src_column	String
dst_column	String
db_user_map	Array		用户映射内容
src	Object
user	String
tgt	Object
user	String
advanced_settings	Object
dump_thd	Number
load_thd	Number
exclude_table_by_features	Object		表示排除掉对应表
PK	Boolean		主键
UK	Boolean		唯一约束
FK	Boolean		外键
INDEX	Boolean		索引
full_sync_custom_cfg	Array		全局自定义配置
key	String		是否启用，0：关，1：开
value	String
enable	String		是否启动
policies	Array		cron数组
policy_type	String
format	Object		文件类型基本设置
header	Number		输出列名，0关1开
delimiter	String		分隔符
quote	String		列引号值
force_quote	Number		列引号值策略 0：不使用 1：列值包含特殊字符时使用 2：始终使用
escape	String		转义符
null	String		NULL值转换
date_format	String		date类型格式
datetime_format	String		datetime类型格式
timestamp_format	String		timestamp类型格式
time_format	String		time类型格式
byte_encode	String		byte数组编码格式 none：原始数组 zero： 原始数组，0x00替换为'\0'即二进制"5c30 base64：base64 hex：hex
encode	String		字符集
outpath	String		备端文件路径
datatag	String		统计列
line_break	String		（源端为文件类型时）文件换行符
full_map_switch	Number		整库映射开关，0关1开
virtual_table	Array		虚拟表列表
user	String		备端用户
tab	String		备端表名
sql	String		sql语句
srcuser	String		源端用户
srctab	String		源端表名

Response

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

离线同步 - 修改

SDK方法名：updateActiveOfflineRule

URL

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

Method

PUT

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rule_name	String
map_type	String		映射类型 整库：db，表：table, 用户schema：user 文件映射：file
src_db_uuid	String		源端数据库uuid
src_db_auth_uuid	String		源端数据库认证用户uuid
tgt_db_uuid	String		备端数据库uuid
tgt_db_auth_uuid	String		备端数据库认证用户uuid
node_uuid	String		备端类型csv时，下发机器节点uuid
src_type	String
tgt_type	String		备端类型
tgt_file_path	String		目标文件路径
file_map	Array		仅源端为文件时	5
src_file_path	String		文件路径	@path
src_file_name	String		文件名	@first
tgt_topic	String		备端topic	@last
advanced_table_map	Array		拓展表映射内容
src	Object		源端
user	String		用户
tab	String		表
tgt	Object		（暂不适用）
user	String
tab	String
column	Object
sync_by_default	Number		同步其余列 0关1开
column_map_list	Array
operate	String		操作类型， 新增：a， 修改：m， 删除：d， 不变：u	a
expression	String		源端表达式	col1+col2
column_name	String		备端列名	newCol
column_type	String		备端列 数据类型	int
src_column_name	String		源端列名
table_map	Array		表映射内容
src_table	String
tgt_table	String
src_db	String
dst_db	String
column	Array
src_column	String
dst_column	String
db_user_map	Array		用户映射内容
src	Object
user	String
tgt	Object
user	String
advanced_settings	Object
dump_thd	Number
load_thd	Number
etl_settings	Object		ETL配置
etl_table	Array
oprType	String
table	String
user	String
process	String
addInfo	String
full_sync_custom_cfg	Array		全局自定义配置
key	String
value	String
policies	Array		cron数组
policy_type	String
format	Object		文件类型基本设置
header	Number		输出列名，0关1开
delimiter	String		分隔符
quote	String		列引号值
force_quote	Number		列引号值策略 0：不使用 1：列值包含特殊字符时使用 2：始终使用
escape	String		转义符
null	String		NULL值转换
date_format	String		date类型格式
datetime_format	String		datetime类型格式
timestamp_format	String		timestamp类型格式
time_format	String		time类型格式
byte_encode	String		byte数组编码格式 none：原始数组 zero： 原始数组，0x00替换为'\0'即二进制"5c30 base64：base64 hex：hex
encode	String		字符集
outpath	String		备端文件路径
datatag	String		统计列
line_break	String		（源端为文件类型时）文件换行符
full_map_switch	Number		整库映射开关，0关1开
virtual_table	Array		虚拟表列表
user	String		用户
tab	String		表名
sql	String		sql语句

Response

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

离线同步 - 状态

SDK方法名：listOfflineRuleStatus

URL

/offline_rule/status

Method

POST

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	String			0
msg	String
data	Array
info_list	Array
rule_uuid	String			@guid
rule_name	String			@first
work_state	Object
status	String
error_code	String
back_state	Object
status	String
error_code	String
status	String
error_code	String

离线同步 - 删除

SDK方法名：deleteOfflineRule

URL

/offline_rule

Method

DELETE

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	String			0
msg	String
data	Object
code	String
message	String
success_list	Array				5
code	String			0
message	String
rule_uuid	String
rule_name	String
fail_list	Array				5
code	String			-1
message	String
rule_uuid	String
rule_name	String
all_list	Array				10
code	String			@pick(1,0)
message	String
rule_name	String
rule_uuid	String

离线同步 - 操作

SDK方法名：operateOfflineRule

URL

/offline_rule/operate

Method

POST

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	String			200
msg	String
data	Object
code	String			@pick(-1,0)
message	String

离线同步 - 字符集

SDK方法名：getOfflineRuleCharset

URL

/offline_rule/charset

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String
charset	Array			["GBK", "UTF-8", "UTF-16BE", "UTF-16LE"]

离线同步 - 单条获取

SDK方法名：describeOfflineRule

URL

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

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
rule_uuid	String			@guid
rule_name	String			@name
src_type	String			@pick("file", "mysql")
tgt_type	String			@pick("file", "mysql")
file_map	Array
src_file_path	String			@sentence
src_file_name	String			@first
tgt_topic	String			@last
map_type	String			file