目录操作

SDK类名：/common/Dir;

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

SDK方法名：listDir

URL

/dir

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
show_file	Number	否	0，不显示，1：显示，默认为1, 是否显示文件	1
node_uuid	String	否	节点uuid，针对已经注册节点, 节点uuid	B8566905-411E-B2CD-A742-77B1346D8E84
dev	Number	否	返回块设备列表：1, 返回块设备，win返回磁盘盘符；0, 正常目录返回	0
path	String	否	（绝对路径），获取盘符（挂载点）时，传 ‘/’；, 指定（父）目录
rep_uuid	String	否	可选，复制规则-cdp恢复时必传，为对应复制规则uuid
bs_time	String	否	可选，复制规则-cdp恢复时必传，为用户选择的【CDP恢复时间点】对应的 baseline 时间点（即：【复制规则-其他操作-cdp baseline 列表 获取】接口中返回的 cdp_time）	2018-10-23_13-23-08
bk_type	String		可选，复制卷选择服务集群获取挂载点时传，值为service_type	service_type
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去拿目录 只在集群复制规则时传，其他情况不传这个参数
vm_name	String		如果是虚机备份目录，返回虚机名称，否则返回空
cluster_config_path	String		可选， HABASE大数据备份时传
page	Number		当前请求第几页	1
type	String		类型：用于获取备份快照路径	'bk_snap'
mount_dir	String		挂载点，恢复时间点里头有
mount_uuid	String		uuid，需前端生成，目录展开下发同一个，保持不变
bk_path	String		备份数据目录
rc_point_in_time	String		恢复时间点
protocol	String		文件合成备份还原需传，iSCSI,FC
fc_initiator_wwpn	String		文件合成备份还原需传，客户端wwpn
fc_target_wwpn	String		文件合成备份还原需传，目标端wwpn
task_uuid	String		【可选】定时还原任务当备机为服务集群时传，根据备份规则uuid获取执行备份具体节点
volume_uuid	String		【可选】定时还原任务获取备份数据目录时传
sto_uuid	String	否	DTO，存储uuid
host_uuid	String	否	DTO，走dto主机时传，不传则走SDK
marker	Number		DTO，分页标记，第一页为''	''
bucket	String		DTO，对象存储桶名称，获取桶下路径时传
ftp_uuid	String	否	DTO，获取FTP存储的文件列表时传
timepoint	Number		DTO，目标存储恢复时间点
mapper_path	String		DTO，目标存储对应源存储路径
is_ssl	Number		rpc使用协议: 0: http; 1: https;
pool_uuid	String		存储池uuid
bk_storage	String		备份存储类型：（文件定时还原，备份存储为重删池，获取目录列表时传） 0：文件系统； 1：对象存储； 2：磁带库； 3：重删池；
dedupe_uuid	String		重删池uuid
is_history_rc	Number		dto恢复，是否为历史恢复：（已废弃） 0：否： 1：是；	0

Response

名称	类型	必选	简介	Mock初始值	Mock规则
data	Object	否
message	String	否	错误提示消息
code	Number	否	错误提示码	0
dir_list	Array	否	子目录内容		100
is_dir	Boolean	否	是否为目录	@boolean
name	String	否	目录或文件名	@word
size	Number	否	文件大小，返回的是"number"，DTO没这个	@integer(100)
time	String	否	创建/修改时间，DTO没这个	@datetime()
sto_type	String		【COLD：归档 WARM：低频STANDARD：标准】	code
thawed_state	Boolean		【1:空白，2:未解冻，3:解冻中，4:解冻完成】	false
mapper_path	String		(DTO存储时返回) DTO目标存储对应源存储路径	C:\ABC
archive_status	Number		【是否归档数据直读】0-否 1-是	1
total	String		总数	1002
page	String		当前页数	1
limit	String		每页条数	1000
prev	Number		可选，获取DTO对象存储时表示上一页标记
next	Number		可选，获取DTO对象存储时表示下一页标记
sto_type	Number				11
ret	Number	否		200
msg	String	否

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

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

SDK方法名：listDir2

URL

/dir2

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
proxy_switch	Number	否	认证类型，0，普通；1，云版（用认证码添加）	0
i2id	String	否	用认证码添加时，认证码
config_addr	String	否	rpcserver 地址， 针对未注册节点, 节点IP	192.168.72.76
config_port	String	否	rpcserver 端口， 针对未注册节点, rpc端口	26821
os_user	String	否	操作系统账户或者auth.conf中配置, 节点认证账号；新建节点，不使用凭据时必传	chenky
os_pwd	String	否	操作系统账户密码或者auth.conf中的配置, 节点认证密码；新建节点，不使用凭据时必传	123qwe
path	String	否	（绝对路径），获取盘符（挂载点）时，传 ‘/’；, 指定（父）目录	/
show_file	Number	否	是否显示文件：0，不显示，1：显示，默认为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，使用凭据时，必传
is_ssl	Number		rpc使用协议: 0: http; 1: https;

Response

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

目录 - 创建目录

SDK方法名：createDir

URL

/dir

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
node_uuid	String	否	安全起见，只有已注册节点允许创建路径, 节点uuid	A608F04B-0CA4-2ECD-794C-5AFD4580E5B9
path	String	否	绝对路径, 要创建的路径	C:\test2\12347\
type	String		大数据备份工作机目录新建时必须传'bigdata_wk'，其他情况空或不传	'bigdata_wk'

Response

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

目录 - 检查路径

SDK方法名：checkDir

URL

/dir/check

Method

POST

Request

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

Response

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

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

SDK方法名：deleteDir;

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

URL

/dir

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
sto_uuid	String	否	存储uuid
host_uuid	String	否	通过dto主机删除时传(不再使用)
bucket	String		通过SDK删除时传
path	String	否		aliyun--oos:/TestDir
names	Array	否
name	String	否		222 - 副本 (2).txt
is_dir	String	否		0

Response

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

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

Response

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

目录 - 备份卷路径

SDK方法名：listEtcdDir;

URL

/dir/etcd_dir

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
node_uuid	String			B8566905-411E-B2CD-A742-77B1346D8E84
path	String

Response

名称	类型	必选	简介	Mock初始值	Mock规则
data	Object
message	String
code	Number			0
dir_list	Array
name	String
type	String		如果是Folder表示目录，可以进一步展开；否则不能展开
ret	Number			200
msg	String

目录 - 操作（DTO云存储）

SDK方法名：operateDtoDir;

URL

/dir/dto_operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
type	Number		0-修改存储类别 1-修改归档数据只读 2-解冻 3-获取桶归档直读配置
sto_uuid	String		存储uuid
host_uuid	String		同步主机uuid
sto_type	String		存储类别【标准存储、低频访问存储、归档存储】
archive_data_direct	Number		归档数据直读【1-启用 0-关闭】
valid_period	Number		有效期【解冻】
rate_type	Number		速率【解冻】
path	Array		桶名，进行操作时可多选，对桶内文件目录进行操作时只会是1个
names	Array
name	String
is_dir	String

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。
archive_data_direct	Number		归档数据直读【1-启用 0-关闭】	0

目录（同get）

URL

/dir/dir

Method

POST

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
dir_list	Array				1-8
is_dir	Boolean			@boolean	1
leaf	Boolean			@boolean	1
name	String			@first
size	String
time	String

目录 - 定时还原文件类型

SDK方法名：listFileBackupDir;

URL

/dir/file_dir

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
bk_uuid	String		备机节点uuid
path	String		当前展开路径
rc_data_path	String		备份数据路径
rc_point	String		还原时间点
bk_storage	Number		备份存储类型： 0：文件系统； 1：对象存储； 2：磁带库； 3：重删池；
sto_uuid	String		对象存储：对象存储uuid
bucket_name	String		对象存储：桶名称
tape_pool_uuid	String		磁带库：磁带池uuid
tape_name	String		磁带库：磁带名
library_sn	String		磁带库：sn序列号
dedupe_uuid	String		重删池：重删池uuid
rc_pathlist_response	Object		文件还原时间点列表返回的参数，需要原样下发给底层
bk_path	Array
rc_time_point_list	Array
bk_data_type	Number
wk_data_type	Number
backup_type	Number
task_uuid	String
blk_direct_copy	String
mount_point	String

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
message	String
code	Number			0
dir_list	Array
is_dir	Boolean			true
time	String			@datetime()
name	String			@word
size	String			@integer(100)
sto_type	String			code
thawed_state	Boolean			false
mapper_path	String			C:\ABC
archive_status	Number			1
total	String			1002
page	String			1
limit	String			1000
prev	Number			1
next	Number			1
sto_type	Number			1