# 存储管理

SDK类名：/common/Storage

# 存储配置 - 新建

SDK方法名：createStorageConfig

# URL

/storage

# Method

POST

# Request

名称	类型	必选	初始值	简介
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	否	1	存储监控开关，用来生成存储使用曲线，0关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

名称	类型	必选	初始值
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规则
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	0
name	Array	["/","/boot"]	+1
biz_grp_list	String
random_str	String	0289FA79-85C3-5D0B-2835-A454EF4A4237

# Response

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

# Response

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

名称	类型	必选	简介
search_value	String	否	可选，搜索字段对应值，如要搜的节点名（可以模糊）
search_field	String	否	可选，搜索字段，如 bk_node_name
limit	Number	否	可选，不传就是全部
page	Number	否	可选，不传就是全部

direction	String	否	可选，排序方向，可选参数 'ASC', 'DESC', 'RANDOM' ，默认 'DESC'；

# Response

名称	类型	必选	初始值
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
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
total	Number	否	1

# 存储配置 - 删除

SDK方法名：deleteStorageConfig

# URL

//storage

# Method

DELETE

# Request

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

# Response

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

# 存储配置 - 状态

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

SDK方法名：listStorageStatus

# URL

//storage/status

# Method

GET

# Request

名称	类型	必选	初始值	简介	Mock规则
uuids	Array	否	["@guid"]

# Response

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

# URL

//storage/device_info

# Method

POST

# Request

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

# Response

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

# 存储配置 - 获取设备信息

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

SDK方法名：describeStorageDeviceInfo

# URL

//storage/device_info

# Method

GET

# Request

名称	类型	必选	初始值	简介	Mock规则
node_uuid	String	否	67E33CDB-D75B-15B3-367D-50C764F5A26F	节点uuid

# Response

名称	类型	必选	初始值	简介
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规则
start	Number	否	1565076908	获取近多久的，就传多久前的时间戳

# Response

名称	类型	必选	初始值	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	否	["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

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

# Response

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

# Response

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

# Response

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

# 配额 - 修改开关值

URL中UUID为存储配置UUID

SDK方法名：switchStorageQuota

# URL

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

# Method

PUT

# Request

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

# Response

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

# 配额 - 新建

URL中UUID为存储配置UUID

SDK方法名：createStorageQuota

# URL

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

# Method

POST

# Request

名称	类型	必选	初始值	简介
user_uuid	String	否		用户uuid，给谁限制配额（从列表选择）
zpool_name	String	否	2.85	增加的zpool名称（页面填的）
zfs_name	String	否	xxx	zfs文件系统的名称（页面填的）
zfs_mount_path	String	否		挂载路径（页面填的）
zfs_quota	Number	否		指定的配额大小（单位G）0为不限制

# Response

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

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

# Response

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

# Response

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

# 配额 - 删除

URL中前面UUID为存储配置UUID

SDK方法名：deleteStorageQuota

# URL

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

# Method

DELETE

# Request

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

# Response

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

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

# URL

/dash_0x

# Method

GET

# Request

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

# Response

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

# 设备 - 获取列表

SDK方法名：listDevice

# URL

//storage/dev

# Method

GET

# Request

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

# Response

名称	类型	必选	初始值
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规则
node_uuid	String	否
config_addr	String			如果不传node_uuid，需要传config_addr

# Response

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

# Response

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

# 存储池 - 创建

SDK方法名：createPool

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

# URL

//storage/pool

# Method

POST

# Request

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

# Response

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

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

# Response

名称	类型	必选	初始值
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规则
node_uuid	String	否
pool_name	String	否

# Response

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

# 存储池 - 获取

SDK方法名：listPool

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

# URL

//storage/pool

# Method

GET

# Request

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

# Response

名称	类型	必选	初始值	简介
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_pool_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规则
node_uuid	String	否
pool_name	String	否	testpool

# Response

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

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

# URL

/dash_1

# Method

GET

# Request

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

# Response

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

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

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

# Response

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

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

# 文件系统 / 快照 - 创建

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

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

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

# Response

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

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

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

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

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

# Response

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

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

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

# Response

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

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

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

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

# Response

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

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

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

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

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

# Response

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

# VMDK - 创建

SDK方法名：createVMDK

# URL

//storage/vmdk

# Method

POST

# Request

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

# Response

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

# VMDK - 删除

SDK方法名：deleteVMDK

# URL

//storage/vmdk

# Method

DELETE

# Request

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

# Response

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

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

# URL

/dash_san

# Method

GET

# Request

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

# Response

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

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

# Response

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

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

# Response

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

# Response

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

名称	类型	必选	初始值
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规则
node_uuid	String	否
path	String	否

# Response

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

# Response

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

# Response

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

# Response

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

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

# Response

名称	类型	必选	初始值
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规则
node_uuid	String	否
auto_add_default_portal	Number	否	0

# Response

名称	类型	必选	初始值
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规则
node_uuid	String	否
auto_add_mapped_luns	Number	否	0

# Response

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

# Response

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

# Response

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

# Response

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

# Response

名称	类型	必选	初始值
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规则
node_uuid	String	否
name	String	否

# Response

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

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

# Response

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

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

# URL

//storage/target_list

# Method

GET

# Request

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

# Response

名称	类型	必选	初始值	简介	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	否	10737418240	容量byte
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

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

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

# Response

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

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

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

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

# Response

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

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

# Response

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

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

# Response

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

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

# Response

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

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

# Response

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

# ISCSI发起者 - 刷新会话

# URL

//storage/initiator/refresh_session

# Method

POST

# Request

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

# Response

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

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

SDK方法名：listTpg

# URL

//storage/tpg/info

# Method

GET

# Request

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

# Response

名称	类型	必选	初始值
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规则
node_uuid	String	否
target_name	String	否

# Response

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

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

# Response

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

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

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

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

# Response

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

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

# Response

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

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

# Response

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

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

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

# Server是否注册

# URL

//storage/server_register

# Method

GET

# Request

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

# Response

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