存储节点

February 26, 2024About 54 min

存储节点

SDK类名：/resource/Storage

存储节点 - 新建

SDK方法名：createStorageConfig

URL

/storage

Method

POST

Request

名称	类型	必选	简介	Mock初始值
name	String	是	配置名称	2.85
type	Number	是	暂时没用，传0	0
bk_uuid	String	是		7E36A0B7-7C9A-D310-645A-F9FF7972F13F
config	Object	否
db_save_day	Number	是	监控数据保留天	2
mon_storage	Number	是	存储监控开关，用来生成存储使用曲线，0关1开，默认关	1
device_info	Array	否	只存需要在状态里显示的设备们
dev_mount	String	否	设备名称	C:\
alarms	Array	否	告警阈值百分比	["80","90"]
biz_grp_list	String	否	分组（前端存的，对后端没用）
backstore	Array	否	SAN管理配置
name	String	否
path	String	否
capacity	String	否
target_name	String	否

Response

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

存储节点 - 修改

SDK方法名：modifyStorageConfig

URL

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

Method

PUT

Request

名称	类型	必选	Mock初始值	Mock规则
name	String	是	test
type	Number	否	0
bk_uuid	String		7E36A0B7-7C9A-D310-645A-F9FF7972F13F
config	Object
mon_storage	Number	是	1
db_save_day	Number	是	30
device_info	Array			2
dev_used_percent	Number		28	+1
dev_name	Array		["/dev/mapper/centos-root","/dev/sda1"]	+1
dev_mount	Array		["/","/boot"]	+1
dev_total	Array		["36.97 GB","0.99 GB"]	+1
dev_free	Array		["26.72 GB","871.58 MB"]	+1
dev_type	String		block
dev_enb_compress	String		N
dev_enb_wight	String		N
dev_save_rate	String		0%
node_name	String		MTQx
node_role	String		3
dev_used_size	Array		["11006136320","149336064"]	+1
alarms	Array		[90,100,70]
disabled	Boolean		true
name	Array	是	["/","/boot"]	+1
biz_grp_list	String
random_str	String		0289FA79-85C3-5D0B-2835-A454EF4A4237

Response

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

存储节点 - 获取单个

SDK方法名：describeStorageConfig

URL

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

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功。
storage	Object	否
name	String	否		name
uuid	String	否		AFAFDFDF-AFAF-AFAF-AFAF-AFAFAFAFAFAF
type	Number	否		0
bk_uuid	String	否		AFAFDFDF-AFAF-AFAF-AFAF-AFAFAFAFAFAF
bk_node_name	String	否		DtrackServer专用,别删改
bk_ip	String	否		192.168.95.243
bk_port	String	否		26825
status	String	否		xxxx
username	String	否		name
config	Object	否	同新建时config

存储节点 - 获取列表

SDK方法名：listStorageConfig

URL

/storage

Method

GET

Request

名称	类型	简介	Mock初始值
search_value	String	可选，搜索字段对应值	118
search_field	String	可选，搜索字段，如 bk_node_name	bk_node_name
limit	Number		1
page	Number		1
direction	String	可选，排序方向，可选参数 'ASC', 'DESC', 'RANDOM' ，默认 'DESC'；

Response

名称	类型	必选	简介	Mock初始值
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功。
info_list	Array	否
bk_node_name	String	否		DtrackServer专用,别删改
bk_ip	String	否		172.20.1.243
bk_port	String	否		26825
db_save_day	Number	否		30
create_fs	Number		0-没有文件系统的配额 1-存在文件系统的配额如果是1则进行提示：是否一并删除存储上所有的文件系统（配额管理创建的）	1
username	String	否		admin
id	String	否		14
name	String	否		san
uuid	String	否		849C7836-F6BB-6737-9457-C0D9AE8E209D
type	Number	否		0
bk_uuid	String	否		AFAFDFDF-AFAF-AFAF-AFAF-AFAFAFAFAFAF
config	Object	否
biz_grp_list	String	否		5BC34A9D-95E4-666D-1F09-C8B7A0D724E1
backstore	Array	否
name	String	否		new bs
path	String	否		/path/new
capacity	String	否		100
target_name	String	否		target_name
status	String	否
create_time	String	否		1563878742
random_str	String	否		A0B14CF0-DFDC-C310-84D3-81B0F60316EC
user_uuid	String	否		1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
can_del	Number			1
total	Number	否		1

存储节点 - 删除

SDK方法名：deleteStorageConfig

URL

/storage

Method

DELETE

Request

名称	类型	必选	简介
uuids	Array	是
delete_quota	Number
force	Number	是	1 - 强制删除 0 - 非强制删除

Response

名称	类型	Mock初始值
msg	String
data	Object
code	Number	11110001
message	String
fail_list	Array
code	Number	11110001
message	String	[-1] 离线
uuid	String	@guid
name	String	test2
success_list	Array
code	Number	11110001
message	String	[0] success
uuid	String	@guid
name	String	test1
ret	Number	200

存储节点 - 状态

只显示该存储中配置的磁盘

SDK方法名：listStorageStatus

URL

/storage/status

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuids	Array	是		["FBDDEBDE-41CC-175B-9D84-4D9693EEB6C6","@guid"]
force_refresh	Number		点击操作栏刷新按钮必传，下发1，表示从rpc获取；其他情况不传

Response

名称	类型	必选	简介	Mock初始值
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] success
status	Array	否
uuid	String	否	存储uuid
status	String	否	节点状态
device_info	Array	否	存储状态
dev_name	String	否		F:\
dev_mount	String	否		F:\
dev_total	String	否		3.986GB
dev_free	String	否		2.918GB
dev_type	String	否		block device
dev_used_percent	String	否		25
dev_enb_compress	String	否		N
dev_enb_wight	String	否		N
dev_save_rate	String	否		0%
node_name	String	否		NzIuNzM=
node_role	String	否		3

存储节点 - 上传设备信息

底层上传存储使用情况，用来显示存储曲线及告警，目前30s上传一次；

字段名称类似、内容与底层RPC接口 rpc.GetAlldevInfo，否则存储图表会无法显示（比如容量单位、设备名称等）

示例URL：https://172.20.79.69:58086/api/storage/device_info，发送时关闭SSL

SDK方法名: uploadDeviceInfo

URL

/storage/device_info

Method

POST

Request

名称	类型	必选	简介	Mock初始值
node_uuid	String	是	节点uuid	67E33CDB-D75B-15B3-367D-50C764F5A26F
device_info	Array	否	设备列表
dev_mount	String	是	win 用卷名，如 C:\； linux 用挂载点，如/home、/boot；	C:\
dev_total	String	是	单位 bytes，总容量	42580570112
dev_free	String	是	单位 bytes，空闲容量	9151045632
dev_used_percent	Number	是	单位 %，磁盘使用百分比	20
Content-Type	String	否		application/json

Response

名称	类型	必选	简介	Mock初始值
ret	Number	否	先判断这个http状态码，200正常	200
msg	String	否
data	Object	否
code	Number	否	再判断这个错误码，0为操作成功	0
message	String	否	错误码非0时，这里会显示错误信息	[0] success

存储节点 - 获取设备信息

新建、修改存储配置时调用，显示设备列表

SDK方法名：describeStorageDeviceInfo

URL

/storage/device_info

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
node_uuid	String	是	节点uuid	7E36A0B7-7C9A-D310-645A-F9FF7972F13F

Response

名称	类型	必选	简介	Mock初始值
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] success
device_info	Object	否
F:\	Object	否	索引
dev_enb_compress	String	否		N
dev_enb_wight	String	否		N
dev_total	String	否		3.986GB
dev_save_rate	String	否		0%
dev_free	String	否		2.918GB
node_name	String	否		NzIuNzM=
node_role	String	否		3
dev_name	String	否		F:\
dev_type	String	否		block device
dev_mount	String	否		F:\
dev_used_percent	String	否		25

存储节点 - 获取曲线图

SDK方法名：describeStorageHistoryData

URL

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

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
start	Number	否	获取近多久的，就传多久前的时间戳	1565076908
type	Number		视图类型： 0：非最近一天视图； 1：最近一天视图；	0

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] success
info_list	Array	否			2
dev_mount	String	否		C:\
time_list	Array	否	时间列表：格式为 Y/m/d 或 H:i	["2019/1/1","2019/1/2"]
dev_total_list	Array	否		["@integer(1000)","@integer(1000)"]
dev_free_list	Array	否		["@integer(1000)","@integer(1000)"]
dev_used_percent_list	Array	否		[20,20,20]

存储节点 - 获取容量信息

SDK方法名：listStorageInfo

URL

/storage/info

Method

GET

Request

名称	类型	必选	简介	Mock初始值
node_uuid	String	否	节点uuid与复制规则uuid二选一, 节点uuid	67E33CDB-D75B-15B3-367D-50C764F5A26F
rep_uuid	String	否	复制规则uuid和节点二选一, 复制规则uuid	F97B3FD5-4D5D-41EE-22A9-740A74E1E13C
byte_format	Number	否	1，有且仅有1enable，其他值忽略, 格式化bytes	1

Response

名称	类型	必选	Mock初始值
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否
driver_list	Object	否
C:	Object	否
name	String	否	C:
total	String	否	42580570112
free	String	否	9151045632
total_cdp_size	String	否	0

存储节点 - 获取可用节点列表

SDK方法名：listAvailableNode;

带是否禁用标记的节点列表，入参同节点-列表接口

URL

/storage/node

Method

GET

Request

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

Response

名称	类型	必选	Mock初始值
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] 操作成功。
info_list	Array	否
username	String	否	admin
cache_path	String	否	C:\Program Files (x86)\info2soft-i2node\cache\
config_addr	String	否	192.168.72.73
data_addr	String	否	192.168.72.73
disk_limit	String	否	40960
log_path	String	否	C:\Program Files (x86)\info2soft-i2node\log\
mem_limit	String	否	819
node_name	String	否	N1_72.73
node_role	String	否	3
node_uuid	String	否	287F1E4B-1CCD-21D9-B9BE-0A72AD62375D
os_type	Number	否	1
os_version	String	否
iscsi_initiator_name	String	否
disabled	Number	否	0
total	Number	否	1

----------------------

URL

/dash_00

Method

GET

Request

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

Response

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

配额 - 修改开关值

URL中UUID为存储配置UUID

SDK方法名：switchStorageQuota

URL

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

Method

PUT

Request

名称	类型	必选	简介	Mock初始值	Mock规则
quota_switch	Number	是		1
random_str	String	是		A5AE270D-B6E5-A3C4-14B4-CAC997B87AB2

Response

名称	类型	必选	Mock初始值
ret	Number	否	200
msg	String	否
data	Object	否

配额 - 新建

URL中UUID为存储配置UUID

SDK方法名：createStorageQuota

URL

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

Method

POST

Request

名称	类型	必选	简介	Mock初始值
user_uuid	String	是	用户uuid，给谁限制配额（从列表选择）
zpool_name	String	否	【可选】创建文件系统必传增加的zpool名称（页面填的）	2.85
zfs_name	String	否	【可选】创建文件系统必传 zfs文件系统的名称（页面填的）	xxx
zfs_mount_path	String	是	挂载路径（页面填的）
zfs_quota	Number	否	【可选】创建文件系统必传指定的配额大小（单位G）0为不限制
compress	Number		压缩 0-不勾选 1-勾选
dedup	Number		删重 0-不勾选 1-勾选
create_fs	Number	是	是否创建文件系统 0-不勾选 1-勾选

Response

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

配额 - 修改

URL中前面UUID为存储配置UUID，

URL中后面UUID为配额配置的UUID，quota_uuid

SDK方法名：modifyStorageQuota

URL

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

Method

PUT

Request

名称	类型	必选	Mock初始值
zpool_name	String	否	2.85
zfs_name	String	否	xxx
zfs_mount_path	String	是
zfs_quota	Number	否	1
random_str	String	是

Response

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

配额 - 获取列表

URL中UUID为存储配置UUID

SDK方法名：listStorageQuota

URL

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

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功。
total	Number	否		1
quota_switch	Number	否	配额限制开关
bk_uuid	String	否
random_str	String	否
info_list	Array	否
quota_uuid	String	否		qouta_uuid
zpool_name	String	否		eeee
zfs_name	String	否		xxx
zfs_mount_path	String	否		/mnt/666/
zfs_quota	Number	否		10
user_uuid	String	否
storage_uuid	String	否	存储配置uuid
create_time	Number	否
random_str	String	否
username	String	否
compress_rate	String		压缩率
dedup_rate	String		重删率

配额 - 删除

URL中前面UUID为存储配置UUID

SDK方法名：deleteStorageQuota

URL

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

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
quota_uuids	Array	是
force	Number		是否强制删除： 0：否； 1：是；	0

Response

名称	类型	必选	简介	Mock初始值
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功。
success_list	Array
fail_list	Array
code	String		10161007删除配额失败
message	String
quota_uuid	String		配额uuid
zfs_name	String		文件系统名称

----------------------

URL

/dash_0x

Method

GET

Request

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

Response

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

设备 - 获取列表

SDK方法名：listDevice

URL

/storage/dev

Method

GET

Request

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

Response

名称	类型	必选	Mock初始值
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] success
disk_tree	Array	否
name	String	否	sda
size	Number	否	1
type	String	否
mount_point	String	否
child_disk	Array	否
name	String	否	sda1
size	Number	否	1
type	String	否
mount_point	String	否

设备 - 获取可用列表

SDK方法名：listAvailableDevice

URL

/storage/available_dev

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
node_uuid	String	否
config_addr	String		如果不传node_uuid，需要传config_addr

Response

名称	类型	必选	Mock初始值
ret	Number	否	200
msg	String	否
data	Object	否
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] success
member_tree	Array	否
name	String	否
size	Number	否	1
type	String	否
available	Number	否	1
child_member	Array	否

----------------------

URL

/dash_0

Method

GET

Request

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

Response

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

存储池 - 创建

SDK方法名：createPool

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/pool

Method

POST

Request

名称	类型	必选	Mock初始值
node_uuid	String	是
count	Number	是	1
dev_list	Array	是
pool_name	String	是

Response

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

存储池 - 扩展

SDK方法名：expandPool

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/pool

Method

PUT

Request

名称	类型	必选	Mock初始值
node_uuid	String	是
count	Number	是	1
dev_list	Array	是
pool_name	String	是

Response

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

存储池 - 删除

SDK方法名：deletePool

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/pool

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
node_uuid	String	是
pool_name	String	是

Response

名称	类型	Mock初始值
ret	Number	200
data	Object
code	Number	0
message	String
msg	String

存储池 - 获取

SDK方法名：listPool

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/pool

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
node_uuid	String	是
pool_name	String	否	可选，传则获取单个，空则获取所有

Response

名称	类型	必选	简介	Mock初始值
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] success
pool_info	Object	否	获取单个返回
name	String	否
size	Number	否		1
alloc	Number	否		1
free	Number	否		1
health	Number	否		1
dev_path	Array	否
dev_count	Number	否		1
array_pools_info	Array	否	获取列表返回
name	String	否
size	Number	否		1
alloc	Number	否		1
free	Number	否		1
health	Number	否		1
zpool_status	Number	否		1
dev_path	Array	否
dev_count	Number	否		1
pool_count	Number	否	获取列表返回	1

存储池 - 获取信息

SDK方法名：listPoolInfo

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/pool/info

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
node_uuid	String	是
pool_name	String	是		testpool

Response

名称	类型	必选	Mock初始值	Mock规则
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] success
array_volume_info	Array	否		8
name	String	否	testpool/clone5
used	String	否	622592
free	String	否	63904940032
refer	String	否	2699837440
type	String	否	volume
capacity	Number	否
array_file_system_info	Array	否		2
name	String	否	testpool
used	String	否	39593705472
free	String	否	63904940032
refer	String	否	102400
mountpoint	String	否	/testpool
type	String	否	filesystem

通过节点rpc来获取池列表

SDK方法名：listPoolFromNode

URL

/storage/pool_from_node

Method

GET

Request

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

Response

名称	类型	Mock初始值
ret	Number	200
msg	String
data	Object
code	Number	0
message	String	[0] success
array_pools_info	Array
name	String
size	Number	1
alloc	Number	1
free	Number	1
health	Number	1
zpool_status	Number	1
dev_path	Array
dev_count	Number	1
pool_count	Number	1

----------------------

URL

/dash_1

Method

GET

Request

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

Response

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

文件系统 - 创建

SDK方法名：createFs

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/file_system

Method

POST

Request

名称	类型	必选
node_uuid	String	是
pool_name	String	是
fs_name	String	是
mountpoint_path	String	否
source_disk_size	String	否

Response

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

文件系统 - 删除

SDK方法名：deleteFs

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/file_system

Method

DELETE

Request

名称	类型	必选	Mock初始值
node_uuid	String	是
pool_name	String	是
fs_name	String	是
force	Number	是	1

Response

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

文件系统 - 获取

SDK方法名：listFs

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/file_system

Method

GET

Request

名称	类型	必选	简介
node_uuid	String	是
pool_name	String	否	可选，获取单个/列表时传
fs_name	String	否	可选，传则获取单个，空则获取所有
eligible_file_system_size	Number	否	可选，获取合适的列表时传，返回空间足够且没有创建过策略的文件系统

Response

名称	类型	必选	简介	Mock初始值
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] success
file_system_info	Object	否	获取单个返回
name	String	否		test
used	Number	否		1
free	Number	否		1
refer	Number	否		1
mountpoint	String	否		12
type	String	否		1
array_file_system_info	Array	否	获取列表返回
name	String	否		test
used	Number	否		1
free	Number	否		1
refer	Number	否		1
mountpoint	String	否		12
type	String	否		1
array_eligible_file_system_info	Array	否	获取合适的列表时返回
name	String	否		test
used	Number	否		1
free	Number	否		1
refer	Number	否		1
mountpoint	String	否		12
type	String	否		1

文件系统 / 快照 - 创建

SDK方法名：createFsSnapshot

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/file_system/snap

Method

POST

Request

名称	类型	必选
node_uuid	String	是
pool_name	String	是
fs_name	String	是
snap_name	String	是

Response

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

文件系统 / 快照 - 删除

SDK方法名：deleteFsSnapshot

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/file_system/snap

Method

DELETE

Request

名称	类型	必选	Mock初始值
node_uuid	String	是
pool_name	String	否
fs_name	String	否
snap_name	String	是
force	Number	是	1

Response

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

文件系统 / 快照 - 获取

SDK方法名：listFsSnapshot

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/file_system/snap

Method

GET

Request

名称	类型	必选	简介
node_uuid	String	是
pool_name	String	否	可选，获取单个/列表时传
fs_name	String	否	可选，获取单个/列表时传
snap_name	String	否	可选，传则获取单个，空则获取所有

Response

名称	类型	必选	简介	Mock初始值
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] success
file_system_snap_prop	Object	否	获取单个返回
name	String	否
used	Number	否		1
free	Number	否		1
refer	Number	否		1
type	String	否
array_file_system_clone_info	Array	否
name	String	否
clone_count	Number	否		1
array_file_system_snap_prop	Array	否	获取列表返回
name	String	否
used	Number	否		1
free	Number	否		1
refer	Number	否		1
mountpoint	String	否
type	String	否
array_file_system_clone_info	Array	否
name	String	否
clone_count	Number	否		1

文件系统 / 快照 / 克隆 - 创建

SDK方法名：createFsCloneSnapshot

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/file_system/snap/clone

Method

POST

Request

名称	类型	必选
node_uuid	String	是
pool_name	String	否
fs_name	String	否
snap_name	String	是
clone_name	String	是

Response

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

文件系统 / 快照 / 克隆 - 删除

SDK方法名：deleteFsCloneSnapshot

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/file_system/snap/clone

Method

DELETE

Request

名称	类型	必选
node_uuid	String	是
pool_name	String	是
clone_name	String	是

Response

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

文件系统 / 快照 / 克隆 - 列表

SDK方法名：listFsCloneSnapshot

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/file_system/snap/clone

Method

GET

Request

名称	类型	必选
node_uuid	String	是
pool_name	String	是
fs_name	String	是
snap_name	String	是

Response

名称	类型	必选	Mock初始值
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] success
array_file_system_clone_info	Array	否
name	String	否

----------------------

URL

/dash_2

Method

GET

Request

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

Response

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

卷 - 创建

SDK方法名：createVolume

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/volume

Method

POST

Request

名称	类型	必选	简介
node_uuid	String	是
pool_name	String	是
volume_name	String	是
volume_size	String	是
volume_attr	Number		是否支持sparse，1是；0否

Response

名称	类型	必选	Mock初始值
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] success
volume_path	String	否	dev/poolname/volumename

卷 - 删除

SDK方法名：deleteVolume

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/volume

Method

DELETE

Request

名称	类型	必选	Mock初始值
node_uuid	String	是
pool_name	String	是
volume_name	String	是
force	Number	是	1

Response

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

卷 - 获取

SDK方法名：listVolume

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/volume

Method

GET

Request

名称	类型	必选	简介
node_uuid	String	是
pool_name	String	否	可选，获取单个/列表时传
volume_name	String	否	可选，传则获取单个，空则获取所有
eligible_volume_size	Number	否	可选，获取合适的列表时传，返回空间足够且没有创建过策略的文件系统

Response

名称	类型	必选	简介	Mock初始值
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] success
volume_info	Object	否	获取单个返回
name	String	否
used	Number	否		1
free	Number	否		1
refer	Number	否		1
type	String	否
path_prefix	String	否
capacity	Number	否
array_volume_info	Array	否	获取列表返回
name	String	否
used	Number	否		1
free	Number	否		1
refer	Number	否		1
mountpoint	String	否
type	String	否
path_prefix	String	否
capacity	Number	否
array_eligible_volume_info	Array	否	获取合适的列表时返回
name	String	否
used	Number	否		1
free	Number	否		1
refer	Number	否		1
mountpoint	String	否
type	String	否
path_prefix	String	否
capacity	Number	否

卷 / 快照 - 创建

SDK方法名：createVolumeSnapshot

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/volume/snap

Method

POST

Request

名称	类型	必选
node_uuid	String	是
pool_name	String	是
volume_name	String	是
snap_name	String	是

Response

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

卷 / 快照 - 删除

SDK方法名：deleteVolumeSnapshot

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/volume/snap

Method

DELETE

Request

名称	类型	必选	Mock初始值
node_uuid	String	是
pool_name	String	是
volume_name	String	否
snap_name	String	否
force	Number	是	1

Response

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

卷 / 快照 - 获取

SDK方法名：listVolumeSnapshot

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/volume/snap

Method

GET

Request

名称	类型	必选	简介
node_uuid	String	是
pool_name	String	是
volume_name	String	是
snap_name	String	否	可选，传则获取单个，空则获取所有

Response

名称	类型	必选	Mock初始值
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] success
volume_snap_prop	Object	否
name	String	否
used	Number	否	1
free	Number	否	1
refer	Number	否	1
type	String	否
array_volume_clone_info	Array	否
name	String	否
clone_count	String	否
array_volume_snap_prop	Array	否
name	String	否
used	Number	否	1
free	Number	否	1
refer	Number	否	1
mountpoint	String	否
type	String	否
array_volume_clone_info	Array	否
clone_count	Number	否	1

卷 / 快照 / 克隆 - 创建

SDK方法名：createVolumeCloneSnapshot

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/volume/snap/clone

Method

POST

Request

名称	类型	必选
node_uuid	String	是
pool_name	String	否
volume_name	String	否
snap_name	String	是
clone_name	String	是

Response

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

卷 / 快照 / 克隆 - 删除

SDK方法名：deleteVolumeCloneSnapshot

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/volume/snap/clone

Method

DELETE

Request

名称	类型	必选
node_uuid	String	是
pool_name	String	是
clone_name	String	是

Response

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

卷 / 快照 / 克隆 - 列表

SDK方法名：listVolumeCloneSnapshot

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/volume/snap/clone

Method

GET

Request

名称	类型	必选
node_uuid	String	是
pool_name	String	是
volume_name	String	是
snap_name	String	是

Response

名称	类型	必选	Mock初始值
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] success
array_volume_clone_info	Array	否
name	String	否

----------------------

URL

/dash_3

Method

GET

Request

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

Response

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

VMDK - 创建

SDK方法名：createVMDK

URL

/storage/vmdk

Method

POST

Request

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

Response

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

VMDK - 删除

SDK方法名：deleteVMDK

URL

/storage/vmdk

Method

DELETE

Request

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

Response

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

---------------------- 存储区域网络（SAN）管理

URL

/dash_san

Method

GET

Request

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

Response

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

后备存储（BackStore） - 创建

SDK方法名：createBackStore

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

除 node_uuid 的其他字段会入库，位置：存储配置-config-backstore

URL

/storage/backstore

Method

POST

Request

名称	类型	必选	简介	Mock初始值
node_uuid	String	是	节点uuid	AFAFDFDF-AFAF-AFAF-AFAF-AFAFAFAFAFAF
name	String	是		name
path	String	是		/path/
capacity	String	否	容量	100

Response

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

后备存储（BackStore） - 删除

SDK方法名：deleteBackStore

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

除 node_uuid 的其他字段会新建bs时入库，位置：存储配置-config-backstore，此删除接口会去掉新建bs入库的条目

URL

/storage/backstore

Method

DELETE

Request

名称	类型	必选	Mock初始值
node_uuid	String	是	AFAFDFDF-AFAF-AFAF-AFAF-AFAFAFAFAFAF
name	String	是	bs
force	Number	是	1

Response

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

后备存储（BackStore） - 获取信息

SDK方法名：listBackStore

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/backstore/info

Method

GET

Request

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

Response

名称	类型	必选	Mock初始值
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] success
backstore	Array	否
name	String	否
path	String	否
capacity	Number	否
is_assign	Number	否

后备存储（BackStore） - 分配给ISCSI发起者

SDK方法名：createAssignBackStore

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/backstore/assign

Method

POST

Request

名称	类型	必选
node_uuid	String	是
name	String	是
target	String	是
tpg_number	String	是
initiator	String	是

Response

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

后备存储（BackStore） - 查看被分配给哪些ISCSI发起者

SDK方法名：listAssignBackStore

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/backstore/assign

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
node_uuid	String	是
path	String	是

Response

名称	类型	必选	Mock初始值
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] success
initiator	Array	否
target	String	否
tpg_number	Number	否	1
initiator	String	否

后备存储（BackStore） - 获取可创建块的盘的路径

SDK方法名：listBackStoreAvailablePath

URL

/storage/backstore/available_path

Method

GET

Request

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

Response

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

ISCSI - 获取版本信息

SDK方法名：describeIscsiVersion

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/iscsi/version

Method

GET

Request

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

Response

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

ISCSI - 获取发现权限

SDK方法名：describeIscsiAuth

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/iscsi/auth

Method

GET

Request

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

Response

名称	类型	必选	Mock初始值
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] success
enable	String	否
userid	String	否
password	String	否
mutual_userid	String	否
mutual_password	String	否

ISCSI - 设置发现权限

SDK方法名：createIscsiDiscoverAuth

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/iscsi/auth

Method

POST

Request

名称	类型	必选
node_uuid	String	否
userid	String	否
password	String	否
mutual_userid	String	否
mutual_password	String	否

Response

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

ISCSI - 取消发现权限

SDK方法名：deleteIscsiDiscoverAuth

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/iscsi/auth

Method

DELETE

Request

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

Response

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

ISCSI - 全局参数设置：自动添加 ISCSI目标端门户

SDK方法名：createAutoAddPortal

URL

/storage/iscsi/auto_add_portal

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
node_uuid	String	否
auto_add_default_portal	Number	否		0

Response

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

ISCSI - 全局参数设置：自动添加单元逻辑号映射

SDK方法名：createAutoAddLun

URL

/storage/iscsi/auto_add_luns

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
node_uuid	String	否
auto_add_mapped_luns	Number	否		0

Response

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

ISCSI - 获取全局参数：自动添加ISCSI目标端门户

SDK方法名：describeAutoAddPortal

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/iscsi/auto_add_portal

Method

GET

Request

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

Response

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

ISCSI - 获取全局参数：自动添加单元逻辑映射

SDK方法名：describeAutoAddLun

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/iscsi/auto_add_luns

Method

GET

Request

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

Response

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

ISCSI目标端 - 获取状态

SDK方法名：describeIscsiTargetStatus

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/target/status

Method

GET

Request

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

Response

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

ISCSI目标端 - 获取信息

SDK方法名：listIscsiTarget

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/target/info

Method

GET

Request

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

Response

名称	类型	必选	Mock初始值
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] success
target	Array	否
name	String	否
tpg	Array	否
tpg_number	Number	否
chap_status	Boolean	否	0
userid	String	否
password	String	否
mutual_userid	String	否
mutual_password	String	否
initiator	Array	否
name	String	否
userid	String	否
password	String	否
mutual_userid	String	否
mutual_password	String	否
lun	Array	否
id	Number	否
backstore	String	否
capacity	Number	否
lun	Array	否
id	Number	否
backstore	String	否
device_path	String	否
capacity	Number	否
portal	Array	否
ip	String	否
port	String	否

ISCSI目标端 - 添加

SDK方法名：createIscsiTarget

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/target

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
node_uuid	String	否
name	String	否

Response

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

ISCSI目标端 - 删除

SDK方法名：deleteIscsiTarget

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/target

Method

DELETE

Request

名称	类型	必选	Mock初始值
node_uuid	String	否
name	String	否
force	Number	否	1

Response

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

ISCSI目标端 - 获取目标端列表

SDK方法名：listIscsiTargetList；

URL

/storage/target_list

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
bk_uuid	String	否	存储uuid

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功。
target_list	Array	否			2
id	String	否
target_name	String	否		''
children	Array	否
id	String	否
name	String	否		newiscsi
tpg_number	Number	否		1
backstore_name	String	否		newiscsi
path	String	否		/dev/pool/logic_pool
capacity	String	否	容量byte	10737418240
target_name	String	否		iqn.1991-05.com.i2soft:newiscsi
_	String	否		6f9930a8114a7

ISCSI发起者 - 添加

SDK方法名：createIscsiInitiator

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/initiator

Method

POST

Request

名称	类型	必选
node_uuid	String	否
target_name	String	否
tpg_number	Number	否
initiator_name	String	否

Response

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

ISCSI发起者 - 删除

SDK方法名：deleteIscsiInitiator

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/initiator

Method

DELETE

Request

名称	类型	必选	Mock初始值
node_uuid	String	否
target_name	String	否
tpg_number	Number	否
initiator_name	String	否
force	Number	否	1

Response

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

ISCSI发起者 - 设置连接权限

SDK方法名：createIscsiInitiatorConnectAuth

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/initiator/auth

Method

POST

Request

名称	类型	必选
node_uuid	String	否
target_name	String	否
tpg_number	Number	否
initiator_name	String	否
user_id	String	否
password	String	否
mutual_userid	String	否
mutual_password	String	否

Response

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

ISCSI发起者 - 添加逻辑单元号（LUN）

SDK方法名：createIscsiInitiatorLun

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/initiator/lun

Method

POST

Request

名称	类型	必选
node_uuid	String	否
target_name	String	否
tpg_number	Number	否
initiator_name	String	否
backstore_name	String	否

Response

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

ISCSI发起者 - 删除逻辑单元号（LUN）

SDK方法名：deleteIscsiInitiatorLun

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/initiator/lun

Method

DELETE

Request

名称	类型	必选	Mock初始值
node_uuid	String	否
target_name	String	否
tpg_number	Number	否
initiator_name	String	否
initiator_lun_no	Number	否	1

Response

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

ISCSI发起者 - 发现目标端

SDK方法名：createIscsiInitiatorDiscoverTarget

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=123

URL

/storage/initiator/discover

Method

POST

Request

名称	类型	必选	Mock初始值
node_uuid	String	否
portal_address	String	否
portal_port	Number	否	1
auth_type	Number	否	1
user_name	String	否
password	String	否
hba_name	String	否

Response

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

ISCSI发起者 - 连接目标端

SDK方法名：createIscsiInitiatorConnectTarget

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=123

URL

/storage/initiator/connect

Method

POST

Request

名称	类型	必选	Mock初始值
node_uuid	String	否
portal_address	String	否
portal_port	Number	否	1
auth_type	Number	否	1
user_name	String	否
password	String	否
target	String	否

Response

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

ISCSI发起者 - 断开目标段连接

SDK方法名：deleteIscsiInitiatorConnectTarget

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=123

URL

/storage/initiator/connect

Method

DELETE

Request

名称	类型	必选
node_uuid	String	否
target_name	String	否
address	String

Response

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

ISCSI发起者 - 获取发现门户列表

SDK方法名：listIscsiInitiatorPortal

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=123

URL

/storage/initiator/portal

Method

GET

Request

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

Response

名称	类型	必选	Mock初始值
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] success
portals	Array	否
initiator_name	String	否
initiator_port_no	Number	否	1
name	String	否
address	String	否
port_no	Number	否	1

ISCSI发起者 - 删除发现门户

SDK方法名：deleteIscsiInitiatorPortal

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=123

URL

/storage/initiator/portal

Method

DELETE

Request

名称	类型	必选	Mock初始值
node_uuid	String	否
address	String	否
port_no	Number	否	1

Response

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

ISCSI发起者 - 刷新会话

SDK方法名：iscsiInitiatorRefreshSession

URL

/storage/initiator/refresh_session

Method

POST

Request

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

Response

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

目标门户组（TPG） - 获取信息

SDK方法名：listTpg

URL

/storage/tpg/info

Method

GET

Request

名称	类型	必选	Mock初始值
node_uuid	String	否
target_name	String	否
tpg_number	Number	否	1

Response

名称	类型	必选	Mock初始值
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否	[0] success
tpg	Array	否
tpg_number	Boolean	否	0
chap_status	Boolean	否	0
userid	String	否
password	String	否
mutual_userid	String	否
mutual_password	String	否
initiator	Array	否
name	String	否
userid	String	否
password	String	否
mutual_userid	String	否
mutual_password	String	否
lun	Array	否
id	Number	否	1
backstore	String	否
capacity	Number	否	1
lun	Array	否
id	Number	否	1
backstore	String	否
device_path	String	否
capacity	Number	否	1
portal	Array	否
ip	String	否
port	String	否

目标门户组（TPG） - 添加

SDK方法名：createTpg

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/tpg

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
node_uuid	String	否
target_name	String	否

Response

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

目标门户组（TPG） - 删除

SDK方法名：deleteTpg

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/tpg

Method

DELETE

Request

名称	类型	必选	Mock初始值
node_uuid	String	否
target_name	String	否
tpg_number	Number	否
force	Number	否	1

Response

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

目标门户组（TPG） - 设置连接权限

SDK方法名：createTpgConnectAuth

URL

/storage/tpg/auth

Method

POST

Request

名称	类型	必选
node_uuid	String	否
target_name	String	否
tpg_number	Number	否
userid	String	否
password	String	否
mutual_userid	String	否
mutual_password	String	否

Response

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

目标门户组（TPG） - 取消连接权限

SDK方法名：deleteTpgConnectAuth

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/tpg/auth

Method

DELETE

Request

名称	类型	必选
node_uuid	String	否
target_name	String	否
tpg_number	Number	否

Response

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

目标门户组（TPG） - 添加逻辑单元（LUN）

SDK方法名：createTpgLun

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

除 node_uuid 的其他字段会入库，位置：存储配置-config-backstore

URL

/storage/tpg/lun

Method

POST

Request

名称	类型	必选	简介	Mock初始值
node_uuid	String	否
tpg_number	Number	否	这个为了RPC	1
target_name	String	否	这个为了RPC
backstore_name	String	否	这个为了RPC
name	String	否	这个为了BackStore入库	name
path	String	否	这个为了BackStore入库	/path/
capacity	String	否	这个为了BackStore入库	100

Response

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

目标门户组（TPG）- 是否开启连接权限

SDK方法名：describeTpgConnectAuth

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/tpg/auth

Method

GET

Request

名称	类型	必选	Mock初始值
node_uuid	String	否
target_name	String	否
tpg_number	Number	否	1

Response

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

目标门户组（TPG） - 删除逻辑单元号（LUN）

SDK方法名：deleteTpgLun

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/tpg/lun

Method

DELETE

Request

名称	类型	必选	Mock初始值
node_uuid	String	否
target_name	String	否
tpg_number	Number	否
tpg_lun_no	Number	否	1
force	Number	否	1

Response

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

目标门户组（TPG） - 添加门户（Portal）

SDK方法名：createTpgPortal

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/tpg/portal

Method

POST

Request

名称	类型	必选
node_uuid	String	否
target_name	String	否
tpg_number	String	否
ip	String	否

Response

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

目标门户组（TPG） - 删除门户（Portal）

SDK方法名：deleteTpgPortal

参见底层接口字段说明：https://apiref.info2soft.com/organization/repository/editor?id=30&mod=124

URL

/storage/tpg/portal

Method

DELETE

Request

名称	类型	必选
node_uuid	String	否
target_name	String	否
tpg_number	Number	否
ip	String	否

Response

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

Server是否注册

SDK方法名：registerServer

URL

/storage/server_register

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
node_uuid	String	否	可选
config_addr	String	否	可选

Response

名称	类型	必选	简介	Mock初始值
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功。
ret_code	Number	否	如果注册了返回该值，且该值为0	0

------ 磁带库管理 ------

URL

/dash/tape

Method

GET

Request

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

Response

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

磁带库 - 列表

SDK方法名：listTape

URL

/tape

Method

GET

Request

名称	类型	简介	Mock初始值
where_args[node_uuid]	String	节点uuid
where_args[pool_uuid]	String	存储池uuid
limit	Number		10
page	Number		1
search_value	String
search_field	String

Response

名称	类型	简介	Mock初始值	Mock规则
msg	String
ret	Number		200
data	Object
count	Number		10
info_list	Array
tape_name	String		磁带库名
tape_uuid	String		磁带库uuid
node_uuid	String		节点uuid
node_name	String		节点名
library_info	Array			1-4
library_sn	String	SYZZ_A	@string
library_vendor	String	STK	STK
library_product	String	L80	L80
library_revision	String	0106	@int(100, 10000)
total	Number			1-100
code	Number		0
message	String

磁带库 - 扫描

SDK方法名：scanTapes;

URL

/tape/scan_tapes

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
node_uuid	String		节点uuid	D42BF707-C971-EEA9-521F-BB0F3F7A92FC

Response

名称	类型	简介	Mock初始值
ret	Number		200
msg	String
data	Object
code	Number		0
message	String		success
library_info	Array	磁带列表
library_sn	String	序列号	SYZZ_A
library_vendor	String	厂商	STK
library_product	String	型号	L80
library_revision	String	版本	0106
drive_num	Number	驱动器数
slot_num	Number	槽数

磁带库 - 新建

SDK方法名：createTape;

URL

/tape

Method

POST

Request

名称	类型	简介	Mock初始值
tape_name	String	磁带库名称	磁带库1
node_uuid	String	节点uuid	D42BF707-C971-EEA9-521F-BB0F3F7A92FC
library_info	Array	磁带列表
library_sn	String	序列号	SYZZ_A
library_vendor	String	厂商	STK
library_product	String	型号	L80
library_revision	String	版本	0106
drive_num	Number	驱动器数
slot_num	Number	槽数

Response

名称	类型	Mock初始值
ret	Number	200
msg	String
data	Object
code	Number	0
message	String	success

磁带库 - 获取单个

SDK方法名：describeTape;

URL

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

Method

GET

Request

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

Response

名称	类型	简介	Mock初始值
ret	Number		200
msg	String
data	Object
message	String
tape	Object
tape_uuid	String
tape_name	String		磁带库1
node_uuid	String		'D42BF707-C971-EEA9-521F-BB0F3F7A92FC'
library_info	Array
library_sn	String		SYZZ_A
library_vendor	String		STK
library_product	String		L80
library_revision	String		0106
drive_num	Number	驱动器数
slot_num	Number	槽数
random_str	String
code	Number		0

磁带库 - 更新

SDK方法名：modifyTape;

URL

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

Method

PUT

Request

名称	类型	Mock初始值
tape_name	String	磁带库1
node_uuid	String	'D42BF707-C971-EEA9-521F-BB0F3F7A92FC'
library_info	Array
library_sn	String	SYZZ_A
library_vendor	String	STK
library_product	String	L80
library_revision	String	0106
random_str	String	'D42BF707-C971-EEA9-521F-BB0F3F7A92FC'

Response

名称	类型	Mock初始值
ret	Number	200
msg	String
data	Object
code	Number	0
message	String

磁带库 - 删除

SDK方法名：deleteTape;

URL

/tape

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
tape_uuids	Array		磁带库uuid

Response

名称	类型	Mock初始值
msg	String
ret	Number	200
data	Object
code	Number	11110001
message	String
success_list	Array
code	Number	11110001
message	String	[0] success
tape_uuid	String	@uuid
tape_name	String	@name
fail_list	Array
code	Number	11110001
message	String	[-1] 找不到节点
tape_uuid	String	@uuid
tape_name	String	@name

磁带库 - 获取slot列表（废弃）

SDK方法名：listSlot;

URL

/tape/slot_list

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
tape_uuid	String		磁带库uuid	93AF0C9F-14C8-41A2-31CB-AAA0F65193FA
library_sn	String		磁带序列号	SYZZY_B

Response

名称	类型	简介	Mock初始值
ret	Number		200
msg	String
data	Object
code	Number		0
message	String
slot_info	Array
slot_index	String	索引	0
slot_flag	String	状态	KNOWN
slot_barcode	String	条形码	E01001L4
slot_tapename	String	磁带名	Backup_2021-01_10_10_23-54
slot_tapesequence	String	序列号	0
dst_type	String	目标类型

磁带库 - 操作

SDK方法名：{operate}Tape

URL

/tape/operate

Method

POST

Request

名称	类型	简介
tape_uuids	Array
library_sn	String	磁带序列号
operate	String	slot操作：删除：erase 格式化：format 浏览：browse 重构catalog：rebuild_catalog 磁带管理：卸载：unload；导入：import；导出：export；磁带池：更新：update_pools;
slot	Array	slot参数（slot操作）
slot _index	String	索引
slot_barcode	String	条形码
slot_tapename	String	磁带名
slot_tapesequence	String	磁带序号
new_slot_tapename	String	（格式化操作时）新的磁带名
drive_index	String	drive索引（卸载）
slot_index	String	slot索引（卸载、导入、导出）
ieslot_index	String	drive索引（导入、导出）
pool_uuid	String	slot操作时传，磁带池uuid

Response

名称	类型	Mock初始值
data	Object
code	Number	0
message	String	success
ret	Number	200
msg	String

磁带库 - slot：获取备份数据

SDK方法名：listBkData;

URL

/tape/bkdata_list

Method

GET

Request

名称	类型	必选	简介	Mock初始值
tape_uuid	String		磁带库uuid
pool_uuid	String		磁带池uuid
library_sn	String		磁带序列号
slot _index	String		slot索引
slot_barcode	String	是	slot条形码
slot_tapename	String		slot磁带名
slot_tapesequence	String		slot序号
page_num	String			0
page_size	String			15
begin_time	String			2021-04-27_00:00:12
end_time	String			2021-04-27_00:00:12
check_rule	Number		0:从磁带库跳转；1代表从备份规则跳转	0
task_uuid	String

Response

名称	类型	简介	Mock初始值
msg	String
ret	Number		200
data	Object
code	Number		0
message	String
total_num	String	记录总数
bkdata_list	Array
bk_index	String	备份编号
bk_path	String	备份路径
bk_time	String	备份时间
slot_index	String
slot_barcode	String
slot_tapesequence	String
archive_size	String	归档数据量
slot_list	Array	session所在磁带信息列表
slot_index	String	slot索引
slot_barcode	String	磁带条形码
slot_flag	String	磁带状态

磁带库 - 查看备份数据下的详细文件

SDK方法名：listBkFile;

URL

/tape/bkfile_list

Method

GET

Request

名称	类型	简介	Mock初始值
tape_uuid	String	磁带库uuid	@guid
pool_uuid	String	磁带池uuid
library_sn	String	磁带序列号	@guid
slot _index	String	slot索引	1
slot_barcode	String	slot条形码	@natural
slot_tapename	String	slot磁带名	@cword(5)
slot_tapesequence	String	slot磁带序号	@natural
bk_index	String	备份索引	index
bk_path	String	备份路径	path
page	Number	页数	1
limit	Number	每页条数	10

Response

名称	类型	简介	Mock初始值	Mock规则
msg	String
ret	Number		200
data	Object
code	Number		0
message	String
bk_files	Array	需要被恢复得文件		15
file_path_name	String		@now('second')
total	Number	页数	45

磁带库 - 获取有磁带的驱动索引

SDK方法名：listBusyDrive;

URL

/tape/busy_drive_list

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
tape_uuid	String		磁带库uuid
library_sn	String	是	磁带库序列号

Response

名称	类型	简介	Mock初始值
msg	String
ret	Number		200
data	Object
message	String
code	Number		0
drives_busy_info	Array
index	String	索引	1
barcode	String	磁带条形码	123

磁带库 - 获取没有磁带的空闲槽

SDK方法名：listFreeSlot;

URL

/tape/free_slot_list

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
tape_uuid	String		磁带库uuid
library_sn	String		磁带库序列号

Response

名称	类型	简介	Mock初始值
msg	String
ret	Number		200
data	Object
message	String
code	Number		0
slots_free_info	Array
index	String	索引	1

磁带库 - 获取有磁带的IE槽

SDK方法名：listBusyIEslot;

URL

/tape/busy_ieslot_list

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
tape_uuid	String		磁带库uuid
library_sn	String		磁带库序列号

Response

名称	类型	简介	Mock初始值
msg	String
ret	Number		200
data	Object
message	String
code	Number		0
ieslots_busy_info	Array
index	String	索引	1
barcode	String	磁带条形码	1

磁带库 - 获取空闲的IE Slot

SDK方法名：listFreeIEslot;

URL

/tape/free_ieslot_list

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
tape_uuid	String		磁带库uuid
library_sn	String		磁带库序列号

Response

名称	类型	简介	Mock初始值
msg	String
ret	Number		200
data	Object
message	String
code	Number		0
ieslots_free_info	Array
index	String	索引	0

磁带库 - 获取有磁带的Slot

SDK方法名：listBusySlot;

URL

/tape/busy_slot_list

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
tape_uuid	String		磁带库uuid
library_sn	String		磁带库序列号

Response

名称	类型	简介	Mock初始值
msg	String
ret	Number		200
data	Object
message	String
code	Number		0
slots_busy_info	Array
index	String	索引	2
barcode	String	磁带条形码	2

磁带库 - 查看磁带详情

SDK方法名：discribeTapeDetail;

URL

/tape/details

Method

GET

Request

名称	类型	简介
pool_uuid	String	磁带池uuid
library_sn	String
slot_index	String
slot_barcode	String
slot_tapename	String
slot_tapesequence	String
bk_index	String	备份编号
bk_path	String	备份路径

Response

名称	类型	简介	Mock初始值
msg	String
data	Object
code	Number		0
message	String
details	Object
task_name	String	规则名
src_type	String	源类型
dst_type	String	目标类型
wk_ip	String	源机地址
bk_ip	String	备机地址
src_path	String	源目录或文件
dst_path	String	目标目录或文件
dst_dir	String	备份目标路径
db_instance	String	数据库实例
storage_name	String	存储池名
volume_name	String	复制卷名
ret	Number		200

磁带池 - 获取列表

SDK方法名：listTapePools;

URL

/tape_pool

Method

GET

Request

名称	类型	简介
limit	Number
page	Number
where_args[tape_uuid]	String	磁带库uuid，必传
where_args[library_sn]	String	磁带库序列号，必传

Response

名称	类型	简介	Mock初始值	Mock规则
msg	String
ret	Number		200
data	Object
code	Number		0
message	String
info_list	Array			1-4
pool_uuid	String		@uuid
pool_name	String	磁带池名称	@cword(2, 8)
pool_flag	Number	磁带池模式 1：归还到公共磁带池 2：保留到当前磁带池		1-2
user_uuid	String		@uuid
username	String
is_public	Number	0：公共池； 1：其他池；		0-1

磁带池 - 获取磁带列表

SDK方法名：listTapePoolSlots;

URL

/tape_pool/list_slots

Method

GET

Request

名称	类型	简介
pool_uuid	String	磁带池uuid
type	Number	0：全部 1：有效 2：自由
is_public	String	移入磁带传1；其余不传或传0

Response

名称	类型	简介	Mock初始值	Mock规则
msg	String
ret	Number		200
data	Object
code	Number		0
message	String
slot_info	Array			1-200
slot_index	String	索引	@string
slot_flag	String	状态	@pick('KNOWN', 'BLANK')
slot_barcode	String	磁带条形码	@string
slot_tapename	String	磁带名	@first
slot_tapesequence	String	磁带序号	@id
slot_type	String	0：有效磁带 1：空白磁带		0-1
slot_expiretime	String	过期时间

磁带池 - 新建

SDK方法名：createTapePool;

URL

/tape_pool

Method

POST

Request

名称	类型	简介
tape_uuid	String
library_sn	String	磁带库序列号
pool_name	String	磁带池名称
pool_flag	String	磁带池模式： 1：归还到公共磁带池 2：保留在当前磁带池

Response

名称	类型	Mock初始值
msg	String
ret	Number	200
data	Object
code	Number	0
message	String

磁带池 - 操作

SDK方法名：operateTapePool;

URL

/tape_pool/operate

Method

POST

Request

名称	类型	简介
pool_uuids	Array	磁带池uuid
operate	String	操作： add_slot：移入； remove_slot：移除； delete：删除； update: 更新磁带池
tape_info	Array
slot_index	String
slot_barcode	String

Response

名称	类型	Mock初始值
msg	String
ret	Number	200
data	Object
code	Number	0
message	String

磁带池 - 获取磁带名

SDK方法名：listTapeNames;

URL

/tape_pool/tape_names

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
pool_uuid	String		磁带池uuid

Response

名称	类型	简介	Mock初始值
ret	Number		200
msg	String
data	Object
code	Number		0
message	String		[0] success
tape_name_info	Array
tape_name	String	磁带名

存储节点

# 存储节点

# 存储节点 - 新建

# URL

# Method

# Request

# Response

# 存储节点 - 修改

# URL

# Method

# Request

# Response

# 存储节点 - 获取单个

# URL

# Method

# Request

# Response

# 存储节点 - 获取列表

# URL

# Method

# Request

# Response

# 存储节点 - 删除

# URL

# Method

# Request

# Response

# 存储节点 - 状态

# URL

# Method

# Request

# Response

# 存储节点 - 上传设备信息

# URL

# Method

# Request

# Response

# 存储节点 - 获取设备信息

# URL

# Method

# Request

# Response

# 存储节点 - 获取曲线图

# URL

# Method

# Request

# Response

# 存储节点 - 获取容量信息

# URL

# Method

# Request

# Response

# 存储节点 - 获取可用节点列表

# URL

# Method

# Request

# Response

# ----------------------

# URL

# Method

# Request

# Response

# 配额 - 修改开关值

# URL

# Method

# Request

# Response

# 配额 - 新建

# URL

# Method

# Request

# Response

# 配额 - 修改

# URL

# Method

# Request

# Response

# 配额 - 获取列表

# URL

# Method

存储节点

存储节点 - 新建

URL

Method

Request

Response

存储节点 - 修改

URL

Method

Request

Response

存储节点 - 获取单个

URL

Method

Request

Response

存储节点 - 获取列表

URL

Method

Request

Response

存储节点 - 删除

URL

Method

Request

Response

存储节点 - 状态

URL

Method

Request

Response

存储节点 - 上传设备信息

URL

Method

Request

Response

存储节点 - 获取设备信息

URL

Method

Request

Response

存储节点 - 获取曲线图

URL

Method

Request

Response

存储节点 - 获取容量信息

URL

Method

Request

Response

存储节点 - 获取可用节点列表

URL

Method

Request

Response

----------------------

URL

Method

Request

Response

配额 - 修改开关值

URL

Method

Request

Response

配额 - 新建

URL

Method

Request

Response

配额 - 修改

URL

Method

Request

Response

配额 - 获取列表

URL

Method

Request