文件比较与同步

SDK类名：/tools/Compare

1 单体-1 新建

SDK方法名：createCompare;

URL

/compare

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
compare	Object	否
excl_path	Array	否	源机排除目录
bkup_policy	Number	否	备份策略，2 立即，0 定时，1 循环；	2
bkup_one_time	Number	否	定时任务，执行时间（备份策略）	0
bkup_schedule	Object	否	周期任务（备份策略）
sched_gap_min	Number	否	间隔分钟数 1-1440	60
sched_time	Array	否	哪几点	["00:00:00"]
sched_day	Array	否	哪几天	["1"]
sched_time_end	String	否	运行时间范围 结束	23:59
limit	Number	否	保留数 1-9999	5
sched_time_start	String	否	运行时间范围 开始	00:00
sched_every	Number	否	0：每天；1：每周：2：每月；3：每隔；	0
mirr_file_check	String	否	校验方式，0：md5；1：文件大小和时间校验，不同则严格校验；2: 文件时间校验，不同则覆盖目标文件；3：文件总是覆写；	1
task_name	String	否	任务名	testCompare1
wk_path	Array	否	工作路径	["E:\test\"]
bk_uuid	String	否	备机节点uuid	67E33CDB-D75B-15B3-367D-50C764F5A26F
cmp_type	Number	否	任务类型，0：只比较，1：比较并同步；	0
bk_path	Array	否	备份路径	["E:\test\"]
wk_uuid	String	否	工作机节点uuid	67E33CDB-D75B-15B3-367D-50C764F5A26F
mirr_sync_attr	Number	否	文件安全属性，0代表不同步安全属性，1代表同步安全属性
compress_switch	Number		传输压缩开关：0，1	0
compress	Number	否	压缩，0关；1：低；2：中；	0
encrypt_switch	String	否	加密开关，0关1开
secret_key	String	否	加密密钥
biz_grp_list	Array	否	业务分组UUID
oph_policy	String	否	孤儿文件处理策略：0不处理，1删除，2移动到指定路径；6 归档；
oph_path	String		孤儿文件，移动到指定路径、归档，必填
ct_name_str1	String	否	文件名转换：prefix string / regex string
ct_name_str2	String	否	文件名转换：suffix string / replace string
ct_name_str3	String	否	文件名转换：restore regex string
ct_name_str4	String	否	文件名转换：restore regex string
data_ip_uuid	String		灾备机数据地址	67E33CDB-D75B-15B3-367D-50C764F5A26F
traversing_sync	Number		遍历时传输： 1-开启 0-不开启
band_width	String		带宽控制：12301:00-02:002m,3412:00-13:006m，按照此类型拼接，没有可不传
task_type	Number		任务类型： 默认不传， 新建模板时传10
file_type_filter_switch	Number		包含0排除1
file_type_filter	String		文件类型过滤，比如：.doc,.docx
pre_work_script	String		比较前源端脚本
pre_back_script	String		比较前备端脚本
post_work_script	String		比较后源端脚本
post_back_script	String		比较后备端脚本

Response

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

单体-1 修改

SDK方法名：modifyCompare;

URL

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

Method

PUT

Request

名称	类型	必选	简介	Mock初始值	Mock规则
compare	Object	否
excl_path	Array	否
bkup_one_time	Number	否		0
bkup_schedule	Object	否
sched_gap_min	Number	否		60
sched_time	Array	否		["00:00:00"]
sched_day	Array	否		["1"]
sched_time_end	String	否		23:59
limit	Number	否		5
sched_time_start	String	否		00:00
sched_every	Number	否		0
mirr_file_check	String	否		1
task_name	String	否		testCompare1
wk_path	Array	否		["E:\test\"]
bk_uuid	String	否		67E33CDB-D75B-15B3-367D-50C764F5A26F
cmp_type	Number	否		0
bk_path	Array	否		["E:\test\"]
bkup_policy	Number	否		2
compress_switch	Number			0
compress	Number	否		0
wk_uuid	String	否		67E33CDB-D75B-15B3-367D-50C764F5A26F
mirr_sync_attr	Number	否		1
encrypt_switch	String	否
secret_key	String	否
biz_grp_list	Array	否
oph_policy	String	否
ct_name_str1	String	否
ct_name_str2	String	否
ct_name_str3	String	否
ct_name_str4	String	否
task_uuid	String	否	任务UUID
random_str	String	否
data_ip_uuid	String		灾备机数据地址	67E33CDB-D75B-15B3-367D-50C764F5A26F
band_width	String		带宽控制：12301:00-02:002m,3412:00-13:006m，按照此类型拼接，没有可不传
task_type	Number		任务类型
file_type_filter_switch	String		包含0排除1
file_type_filter	String		文件类型过滤，比如：.doc,.docx
pre_work_script	String
pre_back_script	String
post_work_script	String
post_back_script	String

Response

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

1 单体-2 获取单个(包括比较结果)

类名：/tools/Compare

方法名：describeCompare

URL

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

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String	否	@mock=
ret	Number	否	@mock=200	200
data	Object	否
code	Number	否	@mock=0	0
compare	Object	否
task_type	Number	否	0：主任务（旧） 1：子任务（旧） 2：主任务（新） 3：子任务（新）	0
wk_uuid	String	否	@mock=, 工作机节点uuid
task_name	String	否	@mock=, 任务名
cmp_type	Number	否	@mock=0, 任务类型，0：只比较，1：比较并同步；	0
result_sum	Object	否	, 结果概览
state_code	Number	否	@mock=0, 结果代码	0
f_diff	Number	否	@mock=123, 不同文件数	123
finish_in	Number	否	@mock=123, 耗时（秒）	123
f_total	Number	否	@mock=0, 文件总数	0
f_missing	Number	否	@mock=123, 丢失文件数	123
total	Number	否	@mock=100, 总文件大小	100
f_skip	Number	否	@mock=123, 相同文件数	123
create_time	Number	否	@mock=1515568566, 任务创建时间	1515568566
bk_uuid	String	否	@mock=, 备机节点uuid
bkup_policy	Number	否	@mock=0, 备份策略，2 立即，0 定时，1 循环；	0
bk_path	Array	否	, 备份路径
status	String	否	@mock=FINISH, SCHEDULED，COMPARING，GENERATING，FINISH	@pick(FINISH, COMPARING, STOP)
bkup_schedule	Object	否	, 周期任务（备份策略）
sched_gap_min	Number	否	@mock=@integer(1, 64), 间隔分钟数	@integer(1, 64)
sched_time	Array	否	@mock=@time('HH:mm'), 哪几点	@time('HH:mm')
sched_every	Number	否	@mock=2, 0：每天；1：每周：2：每月；3：每隔；	2
sched_time_end	String	否	@mock=@time('HH:mm'), 运行时间范围 结束	@time('HH:mm')
sched_day	Array	否	@mock="@integer(1, 31)", 哪几天	"@integer(1, 31)"
limit	Number	否	@mock=@integer(1, 64), 数据保留期限（天）	@integer(1, 64)
sched_time_start	String	否	@mock=@time('HH:mm'), 运行时间范围 开始	@time('HH:mm')
user_uuid	String	否	@mock=@pick(["1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC","1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC"]), 操作者用户名uuid	@pick(["1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC","1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC"])
start_time	Number	否	@mock=1508833766, 开始时间，unix时间戳	1508833766
task_uuid	String	否	@mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 任务id	7AD64D7A-7D1D-AC51-5DF1-29A58345A288
bkup_one_time	Number	否	@mock=1515568566, 定时任务，执行时间（备份策略）	1515568566
mirr_file_check	String	否	@mock=1, 校验方式，0：md5；1：文件大小和时间；	1
end_time	Number	否	@mock=1508833953, 结束时间，unix时间戳	1508833953
compress	Number	否	@mock=0, 压缩，0关；1：低；2：中；	0
excl_path	Array	否	源机排除目录
wk_path	Array	否	工作路径
raw_uuid	String	否		7AD64D7A-7D1D-AC51-5DF1-29A58345A288
is_biz_admin	Number	否	授权标记
can_up	Number	否	授权标记
can_op	Number	否	授权标记
can_del	Number	否	授权标记
thread_num	Number		并行任务数量	4
data_ip_uuid	String		灾备机数据地址	7AD64D7A-7D1D-AC51-5DF1-29A58345A288
band_width	String		带宽控制：12301:00-02:002m,3412:00-13:006m，按照此类型拼接，没有可不传
message	String	否		[0] success

1 单体-2 获取比较结果详情

详见

i2soft / i2cc / webapi / api /

底层日志 / i2node日志 / 规则/任务日志 接口；

http://rap.info2soft.com/workspace/myWorkspace.do?projectId=3#225;

SDK方法名：listCompareLogs;

URL

/logs

Method

GET

Request

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

Response

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

2 列表-1 获取列表

获取列表详细入参说明详见【节点管理-获取节点列表】接口说明；

类名：/tools/Compare

方法名：listCompare

URL

/compare

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
limit	Number	否	, 可选，不传就是全部	10
page	Number	否	, 可选，不传就是全部	1
search_field	String	否	, 可选，搜索字段
search_value	String	否	, 可选，搜索字段对应值（可以模糊）
type	String		任务类型： 获取模板时传10；获取规则时不传

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String	否	@mock=
data	Object	否
total	Number	否	@mock=100, 规则总数	100
code	Number	否	@mock=0	0
info_list	Array	否			10
bk_uuid	String	否	@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机节点uuid	0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
end_time	Number	否	@mock=1508833953, 结束时间，unix时间戳	1508833953
wk_uuid	String	否	@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机节点uuid	0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
username	String	否	@mock=@pick(["admin", "user"]), 所有者	@pick(["admin", "user"])
bkup_policy	Number	否	@mock=2, 备份策略，0立刻，1定时，2周期	@pick([0, 1])
status	String	否	@mock=FINISH, SCHEDULED，COMPARING，GENERATING，FINISH	FINISH
result_sum	Object	否	, 结果概览
f_missing	Number	否	@mock=123, 丢失文件数	123
f_total	Number	否	@mock=0, 文件总数	0
f_skip	Number	否	@mock=123, 相同文件数	123
total	Number	否	@mock=100, 总文件大小	100
finish_in	Number	否	@mock=123, 耗时（秒）	123
state_code	Number	否	@mock=0, 结果代码	0
f_diff	Number	否	@mock=123, 不同文件数	123
last_result_sum	Object		上次执行结果。规则执行完毕被新result_sum覆盖
f_missing	String		@mock=123, 丢失文件数
f_total	String		@mock=0, 文件总数
f_skip	String		@mock=123, 相同文件数
total	String		@mock=100, 总文件大小
finish_in	String		@mock=123, 耗时（秒）
state_code	String		@mock=0, 结果代码
f_diff	String		@mock=123, 不同文件数
wk_node_name	String	否	@mock=@pick(["Smith", "Will", "Nary"]), 工作机节点名	@pick(["Smith", "Will", "Nary"])
user_uuid	String	否	@mock=@pick(["1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC","1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC"]), 操作者用户名uuid	@pick(["1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC","1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC"])
bk_node_name	String	否	@mock=@pick(["kevin", "Jane", "Grey"]), 备机节点名	@pick(["kevin", "Jane", "Grey"])
start_time	Number	否	@mock=1508833766, 开始时间，unix时间戳	1508833766
task_uuid	String	否	@mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 任务id，如果节点和规则id都不传，则全部	7AD64D7A-7D1D-AC51-5DF1-29A58345A288
task_name	String	否	@mock=task_name, 任务名	task_name
create_time	Number	否	@mock=1515568566, 任务创建时间	1515568566
task_type	Number	否	比较任务类型: 旧类型：0：主任务，1：子任务 新类型：2：主任务，3：子任务	2
can_up	Number			1
can_op	Number			1
can_del	Number			1
message	String	否	@mock=[0] success	[0] success
ret	Number	否	@mock=200	200

2 列表-1.1 获取结果列表（周期）

类名：/tools/Compare

方法名：listCircleCompareResult

URL

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

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
limit	Number	否	可选，不传就是全部	10
page	Number	否	可选，不传就是全部	1
search_field	String	否	可选，搜索字段
search_value	String	否	可选，搜索字段对应值（可以模糊）

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否	@mock=200	200
msg	String	否	@mock=
data	Object	否
code	Number	否	@mock=0	0
message	String	否	@mock=[0] success	[0] success
total	Number	否	@mock=100, 规则总数	100
info_list	Array	否			10
task_uuid	String	否	@mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 任务id，如果节点和规则id都不传，则全部	7AD64D7A-7D1D-AC51-5DF1-29A58345A288
wk_uuid	String	否	@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 工作机节点uuid	0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
bk_node_name	String	否	@mock=@pick(["kevin", "Jane", "Grey"]), 备机节点名	@pick(["kevin", "Jane", "Grey"])
username	String	否	@mock=@pick(["admin", "user"]), 所有者	@pick(["admin", "user"])
bk_uuid	String	否	@mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机节点uuid	0DD4E727-70AB-62C6-BEB5-D012DFAE46E3
start_time	Number	否	@mock=1508833766, 开始时间，unix时间戳	1508833766
user_uuid	String	否	@mock=@pick(["1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC","1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC"]), 操作者用户名uuid	@pick(["1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC","1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC"])
end_time	Number	否	@mock=1508833953, 结束时间，unix时间戳	1508833953
task_name	String	否	@mock=task_name, 任务名	task_name
status	String	否	@mock=FINISH, SCHEDULED，COMPARING，GENERATING，FINISH	FINISH
bkup_policy	Number	否	@mock=0, 备份策略，0立刻，1定时，2周期	0
raw_uuid	String	否	@mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 父任务id	7AD64D7A-7D1D-AC51-5DF1-29A58345A288
create_time	Number	否	@mock=1515568566, 任务创建时间	1515568566
result_sum	Object	否	, 结果概览
f_total	Number	否	@mock=0, 文件总数	0
total	Number	否	@mock=100, 总文件大小	100
f_missing	Number	否	@mock=123, 丢失文件数	123
finish_in	Number	否	@mock=123, 耗时（秒）	123
f_diff	Number	否	@mock=123, 不同文件数	123
state_code	Number	否	@mock=0, 结果代码	0
f_skip	Number	否	@mock=123, 相同文件数	123
start_time	Number		起始时间戳
end_time	Number		结束时间戳
transfer_bytes	Number		文件传输数据大小，单位byte
wk_node_name	String	否	@mock=@pick(["Smith", "Will", "Nary"]), 工作机节点名	@pick(["Smith", "Will", "Nary"])

2 列表-2 状态

类名：/tools/Compare

方法名：listCompareStatus

URL

/compare/status

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
task_uuids	Array	否	必传，uuid数组，页面加载第一次获取状态一个一个获取，之后是批量获取；	["11111111-1111-1111-1111-111111111111"]
force_refresh	Number		点击操作栏刷新按钮必传，下发1，表示从rpc获取；其他情况不传

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
data	Object	否
message	String	否		[0] success
status	Object	否
progress	Number	否	进度	0
result_sum	Object	否	结果概览
f_missing	Number	否	丢失文件数	123
state_code	Number	否	结果代码	0
f_diff	Number	否	不同文件数	123
total	Number	否	总文件大小	100
f_skip	Number	否	相同文件数	123
finish_in	Number	否	耗时（秒）	123
f_total	Number	否	文件总数	0
already_cmp_num	Number	否	已比较次数	1
sub_task_num	Number	否	子任务数量	1
task_uuid	String	否	任务id	7AD64D7A-7D1D-AC51-5DF1-29A58345A288
status	Number	否	@mock=FINISH, SCHEDULED，COMPARING，GENERATING，FINISH	FINISH
blist	Number		遍历未完成： 0：否； 1：是；
file_total	String		文件总数
file_current	String		当前文件数
code	Number	否		0
count	Number	否		0
msg	String	否

2 列表-4 操作

类名：/tools/Compare

方法名：[action] + 'Compare'

URL

/compare/operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
operate	String	否	下载：download，删除：delete（与独立的删除接口效果等同； 立即执行: start_immediately； 停止：stop；	download
task_uuids	Array	否	必传	["11111111-1111-1111-1111-111111111111"]

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否	@mock=200	200
msg	String	否	@mock=
data	Object	否
file_name	String	否	@mock=CPR_20180207164539.zip	CPR_20180207164539.zip
message	String	否	@mock=[0] 操作成功	[0] 操作成功
code	Number	否	@mock=0	0
download_url	String	否	@mock=E:\ctrlcenter\wwwroot\default\public\download\CPR_20180207164539.zip	E:\ctrlcenter\wwwroot\default\public\download\CPR_20180207164539.zip

2 列表-3 删除

类名：/tools/Compare

方法名：deleteCompare

URL

/compare

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
task_uuids	Array	否	规则数组	["11111111-1111-1111-1111-111111111111"]
force	Number		1 - 强制删除 0 - 非强制删除

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
data	Object
code	Number			11110001
message	String
fail_list	Array
code	Number			11110001
message	String			[-1] 离线
task_uuid	String			E28184D8-869B-BF56-A77C-3CC835FAAC34
task_name	String			test2
success_list	Array
code	Number			11110001
message	String			[0] success
task_uuid	String			EA8184D8-869B-BF56-A77C-3CC835FAAC34
task_name	String			test1
ret	Number			200

接收任务执行结果

SDK方法名：collectCompareResult

URL

/compare/collect_result

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
code	String	否	任务执行结果code	0
time	String	否	任务起始时间戳时间-结束时间	1632453814-1632453816
files	String	否	总文件数量	100
bytes	String	否	总文件大小	1024
transfer_bytes	String		传输文件大小	10
missing	String	否	缺失文件数量	1
diff	String	否	不同文件数量	2
equal	String	否	相同文件数量	97
erro	String	否	同步出错文件数量	2
task_uuid	String	否	比较任务uuid	@guid

Response

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