# 目录操作

SDK类名：/common/Dir

# 目录 - 列举（子）目录结构（节点已注册）

SDK方法名：listDir

# URL

/dir

# Method

GET

# Request

名称	类型	必选	初始值	简介
show_file	Number	否	1	0，不显示，1：显示，默认为1, 是否显示文件
node_uuid	String	否	B8566905-411E-B2CD-A742-77B1346D8E84	节点uuid，针对已经注册节点, 节点uuid
dev	Number	否	0	返回块设备列表：1, 返回块设备，win返回磁盘盘符；0, 正常目录返回
path	String	否		（绝对路径），获取盘符（挂载点）时，传 ‘/’；, 指定（父）目录
rep_uuid	String	否		可选，复制规则-cdp恢复时必传，为对应复制规则uuid
bs_time	String	否	2018-10-23_13-23-08	可选，复制规则-cdp恢复时必传，为用户选择的【CDP恢复时间点】对应的 baseline 时间点（即：【复制规则-其他操作-cdp baseline 列表获取】接口中返回的 cdp_time）
sto_uuid	String	否		可选，获取DTO对象存储的文件列表时传
ftp_uuid	String	否		可选，获取DTO FTP存储的文件列表时传
host_uuid	String	否		可选，获取DTO同步机的文件列表时、获取DTO对象存储的文件列表时都传
for_vp_file_rc	Number	否		用于vp文件恢复时传1否则不传或者传0
cred_uuid	String	否		可选，从大数据平台获取要备份的数据时可能会用到
auth_user	String	否		可选，从大数据平台获取要备份的数据时可能会用到
auth_key	String	否		可选，从大数据平台获取要备份的数据时可能会用到
for_big_data	Number	否		可选，从大数据平台获取要备份的目录或者获取备机目录时置1。其他方式不设置。
mscs_group_ip	String	否		集群应用IP，集群复制规则应该通过应用IP去拿目录
只在集群复制规则时传，其他情况不传这个参数

# Response

名称	类型	必选	初始值	简介	Mock规则
data	Object	否
message	String	否		错误提示消息
code	Number	否	0	错误提示码
dir_list	Array	否		子目录内容	100
is_dir	Boolean	否	@boolean	是否为目录
name	String	否	@word	目录或文件名
size	Number	否	@integer(100)	文件大小，返回的是"number"，DTO没这个
time	String	否	@datetime()	创建/修改时间，DTO没这个
ret	Number	否	200
msg	String	否

# 目录 - 列举（子）目录结构（节点未注册）

地址和已注册节点一致，只是为了去掉“检测到重复接口”的警告

SDK方法名：listDir

# URL

/dir2

# Method

GET

# Request

名称	类型	必选	初始值	简介
proxy_switch	Number	否	0	认证类型，0，普通；1，云版（用认证码添加）
i2id	String	否		用认证码添加时，认证码
config_addr	String	否	192.168.72.76	rpcserver 地址，针对未注册节点, 节点IP
config_port	String	否	26821	rpcserver 端口，针对未注册节点, rpc端口
os_user	String	否	chenky	操作系统账户或者auth.conf中配置, 节点认证账号；新建节点，不使用凭据时必传
os_pwd	String	否	123qwe	操作系统账户密码或者auth.conf中的配置, 节点认证密码；新建节点，不使用凭据时必传
path	String	否	/	（绝对路径），获取盘符（挂载点）时，传 ‘/’；, 指定（父）目录
show_file	Number	否	1	是否显示文件：0，不显示，1：显示，默认为1,；
for_vp_file_rc	Number	否		0关1开，VP文件级恢复时，传 path（首次从/mnt/dev/）、ip（获取虚机ip接口返回的）、port（默认26821）
use_credential	Number	否	0	是否使用凭据，初始值默认为0
cred_uuid	String	否		凭据uuid，使用凭据时，必传

# Response

名称	类型	必选	初始值	简介	Mock规则
data	Object	否
message	String	否		错误提示消息
dir_list	Array	否		子目录内容	15
is_dir	Boolean	否	@boolean	是否为目录
time	String	否	@datetime()	创建/修改时间
size	String	否	@integer(100)	文件大小，返回的是"number"
name	String	否	@word	目录或文件名
code	Number	否	0	错误提示码
ret	Number	否	200
msg	String	否

SDK方法名：createDir

# URL

/dir

# Method

POST

# Request

名称	类型	必选	初始值	简介	Mock规则
node_uuid	String	否	B8566905-411E-B2CD-A742-77B1346D8E84	安全起见，只有已注册节点允许创建路径, 节点uuid
path	String	否	E:\test2\	绝对路径, 要创建的路径

# Response

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

# 目录 - 检查路径

SDK方法名：checkDir

# URL

/dir/check

# Method

POST

# Request

名称	类型	必选	初始值	简介	Mock规则
node_uuid	String	否	B8566905-411E-B2CD-A742-77B1346D8E84	, 节点uuid
path	String	否	E:\test2\	多个路径用英文逗号隔开, 检查的路径

# Response

名称	类型	必选	初始值	简介
ret	Number	否	200	@mock=200
msg	String	否
data	Array	否
code	Number	否	10021001	@mock=10021001
message	String	否
check_result	String	否	@string("lower", 5)	@mock=@string("lower", 5), 检查结果,返回不存在的路径，多个路径逗号连接

# 目录 - 删除文件/路径（DTO云存储）

SDK方法名：deleteDir;

这个接口只管下发删除命令，删除成功与否需要调下面那个去拿

# URL

//dir

# Method

DELETE

# Request

名称	类型	必选	初始值	简介
sto_uuid	String	否		DTO存储uuid
host_uuid	String	否
path	String	否	aliyun--oos:/TestDir
names	Array	否
name	String	否	222 - 副本 (2).txt
is_dir	String	否	0

# Response

名称	类型	必选	初始值	简介
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] 操作成功
task_uuid	String	否		删除任务id，需要拿这个取删除结果

# 目录 - 删除的结果（DTO云存储）

SDK方法名：describeDirDelStatus;

# URL

//dir/del_status

# Method

GET

# Request

名称	类型	必选	简介
host_uuid	String	否
sto_uuid	String	否	DTO存储uuid
task_uuid	String	否	删除接口返回的task_uuid

# Response

名称	类型	必选	初始值	简介
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] 操作成功
status	String	否		finish: >= 256
del_count	Number	否	0
start_time	Number	否	0
finish_time	Number	否	0
task_uuid	String	否

# 目录操作

# 目录 - 列举（子）目录结构（节点已注册）

# URL

# Method

# Request

# Response

# 目录 - 列举（子）目录结构（节点未注册）

# URL

# Method

# Request

# Response

# 目录 - 创建目录

# URL

# Method

# Request

# Response

# 目录 - 检查路径

# URL

# Method

# Request

# Response

# 目录 - 删除文件/路径（DTO云存储）

# URL

# Method

# Request

# Response

# 目录 - 删除的结果（DTO云存储）

# URL

# Method

# Request

# Response