对象存储保护

SDK类名：/dto/Dto

规则 - 新建

SDK方法名：createDtoRule;

URL

/dto/rule

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
enable	Number	否	是否启用：0否1是	0
rule_name	String	否	名称
rule_type	Number	否	规则类型：0：同步规则；1：恢复规则；2：比较规则； 3：解冻规则；	0
sync_type	Number	否	同步类型：1：静态同步；2：动态同步；3：仅比较；4：比较并同步；5：FTP比较并同步；（旧：规则类型）6：文件清单同步
policy_type	Number	否	同步策略类型：0：手动同步；1：定期同步；2：间隔同步；	0
policy_str	String	否	同步策略定义：（星期天为0） 1）当同步策略为“手动同步”时，该项为空； 2）当同步策略为“定期同步”时，该项定义如下（|	前后都有空格）： D::1,2,3=8:00,9:00,10:00
sync_uuid	String	否	同步机uuid
wk_uuid	String	否	（比较）比较源存储（FTP比较同步时只能用FTP服务器）
wk_path	Array	否	同步规则时为源路径（同步机上的路径）， 还原时为目标路径（同步机上的路径）， 比较时为源路径（源存储上的路径）
bk_uuid	String	否	（还原、解冻、比较）比较的目标存储uuid，（还原、解冻）的源存储（FTP比较同步时只能用本地存储）
bk_path	Array	否	同步规则时为目标路径（目标存储上的路径）， （还原、解冻）时为源路径（源存储上的路径）， 比较时为目标路径（目标存储上的路径）
excl_path	Array	否	排除路径
file_type_filter_switch	Number	否	文件后缀名过滤，1 包含，2 排除	0
file_type_filter	String	否	以后缀名为过滤条件，格式为“.文件扩展名”；若多个过滤条 件则用逗号隔开，如：.txt,.doc,.rtf
compare_type	Number	否	（同步、比较）比较类型：0： 文件属性校验(大小+修改时间)；1：MD5校验；2：文件大小；3：对象智能比对(需要存储支持自定义META) ；	0
oph_policy	Number	否	（比较）孤儿文件处理方式：0：不处理；1：确认后删除；2：直接删除	0
bk_name_opt	Number	否	（同步）对象文件路径名：0：和源端保持不变；1：全部为大写；2：全部为小写；	0
trans_thread_num	Number	否	传输线程数量，1-100	0
obj_scan_thread_num	Number	否	（还原、解冻、比较）对象存储扫描线程数量，1-10	0
cmp_thread_num	Number	否	（比较）比对线程数量	0
cmp_algorithm	Number	否	（比较）比对算法，1：小目录先扫描后比对；2：大目录边扫描边比对（页面上暂不显示，传死值1）	0
cmp_result_limit	Number	否	（比较）保留结果数量	0
band_width	String	否	（同步、比较）带宽设置； 周几几几几点-几点限速（单位k/m）；如 1234508:00-18:00100m,0500:00-23:00200k ，意为，周一到周五8点到18点限速100m，周日和周五0点到23点限速200k
app_db_up_switch	Number	否	（同步）是否启用映射更新，0否1是	0
app_db_up_type	String	否	（同步）应用数据库类型：Oracle / SQLServer	0
app_db_up_sql	String	否	（同步）更新映射的SQL语句	0
archive_flag	Number	否	（比较）是否启用归档，0关1开， 归档只有在 孤儿文件处理方式、压缩、加密 都关闭的情况下才能开启； 归档只支持本地存储到对象存储；	1
archive_type	Number	否	（比较）归档类型，0：同步所有文件，并删除本地符合条件的文件；1：只同步并删除符合条件的文件，默认0	1
archive_days	Number	否	（比较）归档条件，创建时间和修改时间早于同步时间的天数，默认90	1
compress	Number	否	压缩（同步）、解压（还原）开关，0关1开；只有比较类型为：对象智能比对(需要存储支持自定义META) 、忽略目标端存在的文件 时可以开启；	0
encrypt	Number	否	加密（同步）、解密（还原）开关，0：关，1：开,只有比较类型为：对象智能比对(需要存储支持自定义META) 、忽略目标端存在的文件 时可以开启；	0
encrypt_pass	String	否	加密（同步）、解密（还原）密码，需要加密；
encrypt_type	String		加密方式，0：普通加密，1：COS服务端加密；
encrypt_key_type	Number		加密（同步）、解密（还原）密钥类型：0：SSE-COS(COS 托管加密密钥)，1：SSE-C(客户提供的加密密钥的服务端加密)
rc_point	Number		默认0，恢复时间点-精确到毫秒
rc_type	Number		恢复类型: 0：普通恢复； 1：历史恢复； 2：解冻； 3：恢复到复制卷
scan_obj_flag	Number		rule_type为2时（比较规则），备端扫描：1-开启 0-关闭	1
archive_object	Object		rule_type为2时（比较规则），归档时间条件
create_time	Number		创建时间：1勾选，0未勾选
modify_time	Number		修改时间：1勾选，0未勾选
access_time	Number		访问时间：1勾选，0未勾选
type	String		或0，与1
name_feature	String		命名特征
file_type	String		文件类型
valid_period	Number		【解冻】有效期
rate_type	Number		【解冻】速率: 0-加急 1-标准
real_path	Array		【还原】用户实际选择的备份到本地的路径。还原的bk_path为底层返回的mapper_path，保持不变
volume_uuid	String		复制卷uuid； 恢复规则，恢复到复制卷时，必传 （rule_type：1，rc_type：3）
file_record	Number		规则传输记录功能是否开启: 0：不开启（默认）； 1：开启；
file_date_filter_switch	Number		文件时间过滤，1 包含，2 排除
file_date_filter_regex	String		输入正则表达式筛选符合日期条件的对象(文件)

Response

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

规则 - 修改

SDK方法名：modifyDtoRule;

URL 参数为：rule_uuid；

URL

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

Method

PUT

Request

名称	类型	必选	简介	Mock初始值	Mock规则
enable	Number	否		0
rule_name	String	否
sync_uuid	String	否
policy_type	Number	否		0
policy_str	String	否
wk_uuid	String	否
wk_path	Array	否
bk_uuid	String	否
bk_path	Array	否
real_path	String		【恢复】用户实际选择的恢复路径
excl_path	Array	否
file_type_filter_switch	Number	否		0
file_type_filter	String	否
compare_type	Number	否		0
oph_policy	Number	否		0
bk_name_opt	Number	否		0
trans_thread_num	Number	否		0
obj_scan_thread_num	Number	否		0
cmp_thread_num	Number	否		0
cmp_algorithm	Number	否		0
cmp_result_limit	Number	否		0
band_width	String	否
app_db_up_switch	Number	否		0
app_db_up_type	Number	否		0
app_db_up_sql	Number	否		0
random_str	String	否
sync_type	Number	否
archive_flag	Number	否		1
archive_type	Number	否		1
archive_days	Number	否		1
compress	Number	否		0
encrypt	Number	否		0
encrypt_pass	String	否
scan_obj_flag	Number		rule_type为2时（比较规则），备端扫描：1-开启 0-关闭	1
archive_object	Object		rule_type为2时（比较规则），归档时间条件
create_time	Number
modify_time	Number
access_time	Number
type	String
name_feature	String
file_type	String

Response

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

规则 - 单个

SDK方法名：describeDtoRule;

URL

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

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功。
dto_rule	Object	否
enable	Number	否		0
rule_uuid	String	否
rule_name	String	否
rule_type	Number	否		0
sync_uuid	String	否
sync_name	String	否
policy_type	Number	否		1
policy_str	String	否
wk_uuid	String	否
wk_name	String	否
wk_path	Array	否
bk_uuid	String	否
bk_name	String	否
bk_path	Array	否
excl_path	Array	否
file_type_filter_switch	Number	否		0
file_type_filter	String	否
compare_type	Number	否		0
oph_policy	Number	否		0
bk_name_opt	Number	否		0
trans_thread_num	Number	否		0
obj_scan_thread_num	Number	否		0
cmp_thread_num	Number	否		0
cmp_algorithm	Number	否		0
cmp_result_limit	Number	否		0
band_width	String	否
app_db_up_switch	Number	否		1
app_db_up_type	String	否		Oracal
app_db_up_sql	String	否		test
random_str	String	否
user_uuid	String	否
username	String	否
create_time	Number	否		0
sync_type	Number	否
scan_obj_flag	Number
archive_object	Object
create_time	Number
modify_time	Number
access_time	Number
type	String
name_feature	String
file_type	String

规则 - 列表

SDK方法名：listDtoRule;

URL

/dto/rule

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
type	Number	否	规则类型：0：同步规则；1：恢复规则；2：比较规则； 3：解冻规则；
limit	Number	否		1
page	Number	否		1
search_value	String	否
search_field	String	否

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功。
total	Number	否		1
info_list	Array	否
enable	Number	否	是否启用：0否1是	1
rule_uuid	String	否	规则uuid	9c420cF9-8EA2-2b5F-cDB4-A5680bC3E9D2
rule_name	String	否	规则名
rule_type	Number	否	是否启用：0否1是	0
sync_uuid	String	否	同步机uuid
user_uuid	String	否	用户uuid
username	String	否	用户名
create_time	Number	否	创建时间	0
sync_type	Number	否	同步类型：1：静态同步；2：动态同步；3：仅比较；4：比较并同步；5：FTP比较并同步；（旧：规则类型）6：文件清单同步
wk_sto_name	String	否	源存储名
bk_sto_name	String	否	目标存储名
sync_host_name	String	否	同步主机名
wk_sto_uuid	String		源存储uuid
bk_sto_uuid	String		目标存储uuid
wk_sto_type	Number		源存储类型： 0：LocalFS; 1：AWS S3; 2：S3 Compatible; 3：Aliyun OSS; 4：Baidu BOS; 5：MS Azure File; 6：MS Azure Blob; 7：Jingdong OSS; 8：Ftp服务器; 9: swift; 10: EMC Atoms; 11: OBS; 12: CT-OOS;	11
bk_sto_type	Number		目标存储类型	11
can_del	Number		删除权限	1
can_op	Number		操作权限	1
state	Object		缓存状态
rule_uuid	String		规则uuid
status	String		规则状态 未知：UNKNOWN, 停止：STOP, 计算中：CALC, 镜像中：MIRROR, 孤儿文件处理中：ORPHAN, 解冻中：THAWING, 比较：COMPARING, 完成：FINISH, 空闲：IDLE, 停止：STOP, 异常：EXCEPTION, 快照中：SNAP
time	Number		状态更新时间戳

规则 - 状态

SDK方法名：listDtoRuleStatus;

URL

/dto/rule/status

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rule_uuids	Array	是	规则uuid列表
force_refresh	Number		点击操作栏刷新按钮必传，下发1，表示从rpc获取；其他情况不传

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功
status	Array	否
rule_uuid	String	否		9c420cF9-8EA2-2b5F-cDB4-A5680bC3E9D2
progress	String	否	百分比=read_bytes/total_bytes	50
status	String	否	未知：UNKNOWN, 停止 表示数据同步完成，可切换，或者用户手动停止：STOP, 准备中 表示扫描中：CALC, 显示百分比表示传输中：MIRROR, 孤儿文件处理中：ORPHAN, 解冻中：THAWING, 比较：COMPARING, 完成：FINISH, 空闲：IDLE, 停止：STOP, 异常：EXCEPTION, 快照中：SNAP	ORPHAN
total_bytes	Number	否	总字节数	0
trans_bytes	Number	否	传输字节数	0
read_bytes	Number	否	读取字节数	0
total	Number	否	文件总数	0
trans	Number	否	传输文件数	0
same	Number	否	相同文件数	0
miss	Number	否	缺失文件数	0
diff	Number	否	不同文件数	0
fail	Number	否	传输失败数	0
thaw	Number		解冻文件数	0
wait_thaw	Number		待解冻文件数	0
rate_type	Number		解冻速率	0

规则 - 删除

SDK方法名：deleteDtoRule;

URL

/dto/rule

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rule_uuids	Array	否
force	Number		1 - 强制删除 0 - 非强制删除

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
data	Object
code	Number			11110001
message	String
fail_list	Array
code	Number			11110001
message	String			[0] success
rule_uuid	String			@guid
rule_name	String			test2
success_list	Array
code	Number			11110001
message	String			[0] success
rule_uuid	String			@guid
rule_name	String			test1
ret	Number			200

规则 - 操作

SDK方法名：{operate}DtoRule;

URL

/dto/rule/operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
operate	String	否	启动：start； 停止：stop； 继续：resume； 失败重传：restart； 禁用：disable； 启用：enable
rule_uuids	Array			["dCf2732A-fBdA-5F3F-cE3f-7989AA8De4cd","17b99b8e-2e11-C1b2-7302-b8ee1BCdF3Bd"]

Response

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

规则 - 文件列表（比较 不同/丢失/失败/孤儿）

SDK方法名：listDtoRuleFile; URL 参数为：rule_uuid；

URL

/dto/rule/:uuid([A-F0-9-]+)/file

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
type	String	否	参数：diff/miss/fail/orphan
page	Number	否
limit	Number	否
result_id	String		result_id

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功
total	Number	否		1
info_list	Array	否
path	String	否	某路径下。。	/
files	String	否	。。有什么文件（逗号分隔）	2
more	Number	否	如果files中多于1000个，则more值为一共多少个，否则more为0

规则 - 文件列表 删除孤儿（比较）

SDK方法名：deleteDtoRuleFile; URL 参数为：rule_uuid；

URL

/dto/rule/:uuid([A-F0-9-]+)/file

Method

DELETE

Request

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

Response

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

规则 - 比较结果（比较）

SDK方法名：listDtoRuleCmpResult; URL 参数为：rule_uuid；

URL

/dto/rule/:uuid([A-F0-9-]+)/cmp_result

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功
info_list	Array	否
id	Number	否		1
total	Number	否	总文件数	0
same	Number	否	丢失文件数	0
miss	Number	否	丢失文件数	1
diff	Number	否	不同文件数	0
trans	Number	否	传输文件数	1
fail	Number	否	失败文件数	1
trans_bytes	Number	否	传输字节数	0
status	String	否	IDEL / STOP / FINISH / EXCEPTION	FINISH
start_time	Number	否	时间戳	1557398375
finish_time	Number	否	时间戳	1557398381
wk_path	Array	否	执行时源路径	["aliyun--oos:/TestDir/222 - 副本 (4).txt"]
bk_path	Array	否	执行时目标路径	["aliyun--oos:/TestDir/222 - 副本 (5).txt"]
excl_path	Array	否	执行时排除路径	[]

规则 - 获取源端对应路径列表

SDK方法名：listDtoRuleSourcePath;

URL

/dto/rule/source_path_list

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
host_uuid	String		源端存储UUID	@guid
host_ip	String		源端ip
timepoint	String			@timestamp()
prefix	String		前缀
mapper_path	String		选中路径的目标路径

Response

名称	类型	必选	简介	Mock初始值	Mock规则
dir_lists	Array
name	String		DTOprefix下的子目录
mapper_path	String		DTO 子目录对应源存储路径
restore_status	String		1:空白，2:未解冻，3:解冻中，4:解冻完成