文件比较与同步

SDK类名：/tools/Compare

1 单体-1 新建

SDK方法名：createCompare;

URL

//compare

Method

POST

Request

名称	类型	必选	初始值	简介	Mock规则
compare	Object	否
excl_path	Array	否		源机排除目录
bkup_policy	Number	否	2	备份策略，2 立即，0 定时，1 循环；
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	0：每天；1：每周：2：每月；3：每隔；
mirr_file_check	String	否	1	校验方式，0：md5；1：文件大小和时间校验，不同则严格校验；2: 文件时间校验，不同则覆盖目标文件；3：文件总是覆写；
task_name	String	否	testCompare1	任务名
wk_path	Array	否	["E:\test\"]	工作路径
bk_uuid	String	否	67E33CDB-D75B-15B3-367D-50C764F5A26F	备机节点uuid
cmp_type	Number	否	0	任务类型，0：只比较，1：比较并同步；
bk_path	Array	否	["E:\test\"]	备份路径
wk_uuid	String	否	67E33CDB-D75B-15B3-367D-50C764F5A26F	工作机节点uuid
mirr_sync_attr	Number	否		文件安全属性，0代表不同步安全属性，1代表同步安全属性
compress_switch	Number		0	传输压缩开关：0，1
compress	Number	否	0	压缩，0关；1：低；2：中；
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

Response

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

单体-1 修改

SDK方法名：modifyCompare;

URL

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

Method

PUT

Request

名称	类型	必选	初始值	简介	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

Response

名称	类型	必选	初始值	简介	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规则

Response

名称	类型	必选	初始值	简介	Mock规则
msg	String	否		@mock=
ret	Number	否	200	@mock=200
data	Object	否
code	Number	否	0	@mock=0
compare	Object	否
task_type	Number	否	0	0：主任务（旧） 1：子任务（旧） 2：主任务（新） 3：子任务（新）
wk_uuid	String	否		@mock=, 工作机节点uuid
task_name	String	否		@mock=, 任务名
cmp_type	Number	否	0	@mock=0, 任务类型，0：只比较，1：比较并同步；
result_sum	Object	否		, 结果概览
state_code	Number	否	0	@mock=0, 结果代码
f_diff	Number	否	123	@mock=123, 不同文件数
finish_in	Number	否	123	@mock=123, 耗时（秒）
f_total	Number	否	0	@mock=0, 文件总数
f_missing	Number	否	123	@mock=123, 丢失文件数
total	Number	否	100	@mock=100, 总文件大小
f_skip	Number	否	123	@mock=123, 相同文件数
create_time	Number	否	1515568566	@mock=1515568566, 任务创建时间
bk_uuid	String	否		@mock=, 备机节点uuid
bkup_policy	Number	否	0	@mock=0, 备份策略，2 立即，0 定时，1 循环；
bk_path	Array	否		, 备份路径
status	String	否	@pick(FINISH, COMPARING, STOP)	@mock=FINISH, SCHEDULED，COMPARING，GENERATING，FINISH
bkup_schedule	Object	否		, 周期任务（备份策略）
sched_gap_min	Number	否	@integer(1, 64)	@mock=@integer(1, 64), 间隔分钟数
sched_time	Array	否	@time('HH:mm')	@mock=@time('HH:mm'), 哪几点
sched_every	Number	否	2	@mock=2, 0：每天；1：每周：2：每月；3：每隔；
sched_time_end	String	否	@time('HH:mm')	@mock=@time('HH:mm'), 运行时间范围 结束
sched_day	Array	否	"@integer(1, 31)"	@mock="@integer(1, 31)", 哪几天
limit	Number	否	@integer(1, 64)	@mock=@integer(1, 64), 数据保留期限（天）
sched_time_start	String	否	@time('HH:mm')	@mock=@time('HH:mm'), 运行时间范围 开始
user_uuid	String	否	@pick(["1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC","1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC"])	@mock=@pick(["1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC","1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC"]), 操作者用户名uuid
start_time	Number	否	1508833766	@mock=1508833766, 开始时间，unix时间戳
task_uuid	String	否	7AD64D7A-7D1D-AC51-5DF1-29A58345A288	@mock=7AD64D7A-7D1D-AC51-5DF1-29A58345A288, 任务id
bkup_one_time	Number	否	1515568566	@mock=1515568566, 定时任务，执行时间（备份策略）
mirr_file_check	String	否	1	@mock=1, 校验方式，0：md5；1：文件大小和时间；
end_time	Number	否	1508833953	@mock=1508833953, 结束时间，unix时间戳
compress	Number	否	0	@mock=0, 压缩，0关；1：低；2：中；
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规则

Response

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

2 列表-1 获取列表

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

类名：/tools/Compare

方法名：listCompare

URL

//compare

Method

GET

Request

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

Response

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

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

类名：/tools/Compare

方法名：listCircleCompareResult

URL

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

Method

GET

Request

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

Response

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

2 列表-2 状态

类名：/tools/Compare

方法名：listCompareStatus

URL

//compare/status

Method

GET

Request

名称	类型	必选	初始值	简介	Mock规则
task_uuids	Array	否	["11111111-1111-1111-1111-111111111111"]	必传，uuid数组，页面加载第一次获取状态一个一个获取，之后是批量获取；

Response

名称	类型	必选	初始值	简介	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	否	7AD64D7A-7D1D-AC51-5DF1-29A58345A288	任务id
status	Number	否	FINISH	@mock=FINISH, SCHEDULED，COMPARING，GENERATING，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规则
operate	String	否	download	下载：download，删除：delete（与独立的删除接口效果等同； 立即执行: start_immediately； 停止：stop；
task_uuids	Array	否	["11111111-1111-1111-1111-111111111111"]	必传

Response

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

2 列表-3 删除

类名：/tools/Compare

方法名：deleteCompare

URL

//compare

Method

DELETE

Request

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

Response

名称	类型	必选	初始值	简介	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规则
code	String	否	0	任务执行结果code
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	否	@guid	比较任务uuid

Response

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