虚拟平台

SDK类名：/resource/VirtualizationSupport;

虚拟平台 - 新建

SDK方法名：createVp

URL

/vp/platform

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
comment	String	否	说明
config_addr	String	否	Npsvr ip地址	192.168.72.75
config_port	Number	否	Npsvr 端口	58083
os_pwd	String	否	平台密码(RSA加密)	12345678
os_usr	String	否	平台用户名	root
vp_addr	String	否	平台ip地址	192.168.88.107
vp_name	String	否	平台名称	test
vp_type	Number	否	平台类型： 0：Vmware； 1：Hyper-V，2：KVM, 3: DRP, 4: 华为云, 5: OpenStack 7: CAS 9: 华为云Stack； 10：Fusion； 11：Winstack；	0
bind_lic_list	Array	否	绑定的软件许可列表，实时生成，不入库
biz_grp_list	Array	否	分组关系, 当前资源绑定的组uuid列表；
use_credential	Number	否	是否使用凭据： 0：不使用 1：使用	0
cred_uuid	String	否	可选，使用凭据时，凭据的uuid
is_drill	Number	否	是否配置演练平台，0，否；1，是
drill_config	Object	否	演练配置，is_drill为1时，必传
proxy_name	String	否	代理网关名称
proxy_ip	String	否	代理网关ip
proxy_mask	String	否	代理网关子网掩码
proxy_gw	String	否	代理网关的网关
new_hostname	String	否	主机名
new_ds	String	否	数据存储
new_dc	String	否	数据中心
new_dcmor	String	否	目标平台数据中心托管对象值
network_name	String	否	目标平台网卡名称
network_id	String	否	目标平台网卡ID
rpc_port	String		目标主机节点端口
orch_vm_network_name	String		演练虚机网卡名称
orch_vm_network_id	String		演练虚机网卡id
is_backup_center	Number		是否作为资源池： 0：否； 1：是；
cc_ip_uuid	String		控制机地址对应的uuid
maintenance	Number			0
connect_port	Number		平台连接端口： 当平台类型为Vmware时 必填 默认443	443
data_transmission_port	Number		数据传输端口： 当平台类型为Vmware时 必填 默认902	902
is_ssl	Number		是否开启安全连接: 0否，1是 当平台类型为Vmware时 必填 默认 1	1

Response

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

虚拟平台 - 获取单个

SDK方法名：describeVp

URL

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

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功
vp_platform	Object	否
username	String	否		admin
vp_uuid	String	否		1663DD96-C9BE-B49E-6044-3AB3120F4B74
vp_name	String	否		88.107
user_uuid	String	否		1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
vp_addr	String	否		192.168.88.107
os_usr	String	否		root
os_pwd	String	否		12345678
config_addr	String	否		192.168.72.75
config_port	String	否		58083
comment	String	否
create_time	String	否		1533871285
random_str	String	否		AB790B28-62D6-7236-612F-65D73C80036F
vp_type	Number	否		0
biz_grp_list	Array	否	分组关系, 当前资源绑定的组uuid列表；	["C58E71F8-4482-4A71-6E5A-46EAF7C45177","D1008DA9-BFD6-FC6A-E795-B66B74F24CC5","030B0DED-10C8-08C7-1218-5BA30A042527"]
bind_lic_list	Array	否		["C58E71F8-4482-4A71-6E5A-46EAF7C45177","D1008DA9-BFD6-FC6A-E795-B66B74F24CC5","030B0DED-10C8-08C7-1218-5BA30A042527"]
cred_uuid	String	否	上一次添加/编辑，使用凭据的uuid
is_drill	Number	否	是否配置演练平台，0，否；1，是
drill_config	Object	否	演练配置
proxy_name	String	否	代理网关名称
proxy_ip	String	否	代理网关ip
proxy_mask	String	否	代理网关子网掩码
proxy_gw	String	否	代理网关的网关
new_hostname	String	否	主机名
new_ds	String	否	数据存储
new_dc	String	否	数据中心
new_dcmor	String	否	目标平台数据中心托管对象值
network_name	String	否	目标平台网卡名称
network_id	String	否	目标平台网卡ID
is_backup_center	Number		是否作为资源池： 0：否； 1：是；	@Integer(0,1)

虚拟平台 - 修改

SDK方法名：modifyVp

URL

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

Method

PUT

Request

名称	类型	必选	简介	Mock初始值	Mock规则
comment	String	否	说明
config_addr	String	否	Npsvr ip地址	192.168.72.75
config_port	Number	否	Npsvr 端口	58083
os_pwd	String	否	平台密码(RSA加密)	12345678
os_usr	String	否	平台用户名	root
vp_addr	String	否	平台ip地址	192.168.88.107
vp_name	String	否	平台名称	test1
vp_type	Number	否	平台类型：0：Vmware；1：Hyper-V，2：FusionShpere	0
bind_lic_list	Array	否	绑定的软件许可列表，实时生成，不入库
biz_grp_list	Array	否	分组关系, 当前资源绑定的组uuid列表；
random_str	String	否		11111111-1111-1111-1111-111111111111
use_credential	Number	否	是否使用凭据： 0：不使用 1：使用	0
cred_uuid	String	否	可选，使用凭据时，凭据的uuid
is_drill	Number	否	是否配置演练平台，0，否；1，是
drill_config	Object	否	演练配置
proxy_name	String	否	代理网关名称
proxy_ip	String	否	代理网关ip
proxy_mask	String	否	代理网关子网掩码
proxy_gw	String	否	代理网关的网关
new_hostname	String	否	主机名
new_ds	String	否	数据存储
new_dc	String	否	数据中心
new_dcmor	String	否	目标平台数据中心托管对象值
network_name	String	否	目标平台网卡名称
network_id	String	否	目标平台网卡ID
maintenance	Number			0
is_backup_center	Number		是否作为资源池： 0：否； 1：是；	0

Response

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

虚拟平台 - 列表

获取平台规则列表，获取列表详细入参说明详见【节点管理-获取节点列表】接口说明；

SDK方法名：listVp

URL

/vp/platform

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
page	Number	否	可选	1
limit	Number	否	可选	10
search_field	String		要搜索的字段: vp_addr: 平台地址； config_addr： 管理地址；
search_value	String		要搜索的字段值
where_args[vp_type]	String		平台类型： 0：VMWARE； 1：HYPER-V； 2：KVM；（暂时不支持） 3：容灾平台； 7：CAS;

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否	@mock=200, http code	200
msg	String	否	提示信息
data	Object	否	api content
code	Number	否	@mock=0	0
total	Number	否	总量数量
info_list	Array	否			3
os_usr	String	否	平台用户名	@name
vp_type	Number	否	平台类型：0：Vmware；1：h3c；2：openstack	3	0-3
vp_uuid	String	否	平台uuid	C0744ABF-5571-8288-1930-439612B6234A
username	String	否	所有者	@name
config_addr	String	否	管理地址	@ip
config_port	Number	否	端口	58083
os_pwd	String	否	平台密码	!@#QWEASD
comment	String	否	备注	@word
vp_name	String	否	平台名称	@word
vp_addr	String	否	平台地址	@ip
random_str	String	否	随机字符串，修改锁，修改则原样传回即可	@guid
create_time	Number	否	创建时间	1515568566
user_uuid	String	否		@guid
is_drill	Number	否	是否配置演练平台，0，否；1，是
can_up	Number			1
can_op	Number			1
can_del	Number			1
message	String	否	错误信息提示

虚拟平台 - 状态

获取平台规则状态

SDK方法名：listVpStatus

URL

/vp/platform/status

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
vp_uuids	Array	否	vp_uuid 数组	["11111111-1111-1111-1111-111111111111"]
force_refresh	Number		点击操作栏刷新按钮必传，下发1，表示从rpc获取；其他情况不传

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功
status	Array	否
status	String	否	ONLINE：在线；OFFLINE：离线；UNKOWN：未知；ERR_TKN：RPC 调用失败；	@pick(["ONLINE", "OFFLINE", "NUKNOW", "ERR_TKN"])
vp_uuid	String	否		@guid
data_agent_version	String	否	数据代理版本
drill_status	Number	否	演练状态，“0”为部署完成，“1”为未部署，“2”为部署中		2
npsvr_version	String	否	npsvr版本

虚拟平台 - 操作

SDK方法名：updateDataAgentVp;

URL

/vp/platform/operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
operate	String	否	update_data_agent：更新数据代理版本;maintain：维护模式	update_data_agent
vp_uuids	Array	否		["11111111-1111-1111-1111-111111111111"]
switch	Number		切换维护模式，0关，1开	0

Response

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

虚拟平台 - 删除

删除虚拟平台，支持批量删除

SDK方法名：deleteVp

URL

/vp/platform

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
vp_uuids	Array	否	要删的平台uuid数组	["11111111-1111-1111-1111-111111111111"]

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String	否	, 提示
data	Object	否	, api content
code	Number	否	@mock=0	0
message	String	否	, 错误信息提示
success_list	Array	否
code	Number	否
message	String	否
vp_uuid	String	否
vp_name	String	否
fail_list	Array	否
code	Number	否
message	String	否
vp_uuid	String	否
vp_name	String	否
ret	Number	否	@mock=200, http code	200

虚拟平台 - 查 虚机列表

获取虚机列表，URL 参数为 vp_uuid

SDK方法名：listVM

URL

/vp/platform/:uuid([A-F0-9-]+)/vm

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
view_type	String		主机视图：hostView； 虚机视图：vmView；
type	String		需要展开的目录类型（顶级不用传）； 具体值同相应字段type
id	String		需要展开的目录id（顶级不用传）
search_name	String		搜索内容（名称/ip）
force_rpc	String		是否强制刷新，1是，0否
show_vm	String		是否返回vm。如果是false，则列表中不返回vm。
region_id	String		区域ID
project_id	String		项目ID

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功
vm_list	Array	否	这个是以前返回的		12
name	String	否	虚机名称或目录名称	Fedora 64bit_crosscompile
type	String		数据中心：Datacenter； 目录：Folder； 集群：ClusterComputeResource 主机：HostSystem； 虚拟机：VirtualMachine； Winstack： pool：主机池； cluster：集群； host：主机； VirtualMachine：虚拟机；	VirtualMachine
time	String	否	保留字段
size	String	否	保留字段
morval	String	否	对象id	20
host_ip	String	否	主机IP	192.168.88.107
power_state	Number		虚机状态 -1：查询失败 1：开机状态 4：挂起状态 5：关机状态
support_cbt	String		CBT是否支持 0：不支持 1：支持 -1：查询失败
exist_rule_type	Number	否	规则类型 1：备份；2：迁移；3：复制；4：恢复；	@int(0,3)
is_dir	String	否	0：虚机名 1：目录	0
cpu	String	否	cpu数
core_per_sock	String	否	单个cpu核数
mem_mb	String	否	内存大小
os_type	Number	否	操作系统： 0：linux； 1：windows
ip	String		导入的虚机ip
uuid	String		虚机uuid标识
rule	Object		虚机已添加的备份规则
rule_name	String		规则名称
rule_type	String		规则类型： 虚机复制：rep 虚机迁移：move 虚机备份：backup
status	String		规则状态	UNKNOW
list	Array		这个是最新返回的
id	String		虚机id或目录id
morval	String		同id
parent_id	String		父级的id
name	String		数据中心名称
type	Number		本层节点类型 （Datacenter表示数据中心，Folder表示目录，ClusterComputeResource表示集群，HostSystem表示主机，VirtualMachine表示虚拟机）	1
children	Array		下层节点信息(VirtualMachine为最末节点)
time	String
size	String
host_ip	String
power_state	String
support_cbt	String
exist_rule_type	String
is_dir	Number		是否目录： 1：是； 0：否；	0
cpu	String
core_per_sock	String
mem_mb	String
os_type	String
uuid	String
ip	String		控制机导入的ip
support_agent	String		cas是否支持代理模式： 0：不支持 1：支持
summary	Object
name	String		虚机名称或目录名称
mor_type	String		Datacenter表示数据中心，Folder表示目录，ClusterComputeResource表示集群，HostSystem表示主机，VirtualMachine表示虚拟机
time	String		保留字段
size	String		保留字段
mor_value	String		虚机id
host_ip	String		主机IP
power_state	String		虚机状态 -1：查询失败 1：开机状态 4：挂起状态 5：关机状态
support_cbt	String		CBT是否支持 0：不支持 1：支持 -1：查询失败
exist_rule_type	String		规则类型 1：备份 2：迁移 3：复制
is_dir	String		0：虚机名 1：目录
cpu_num	String		虚拟机cpu个数
cores_per_cpu	String		单个cpu核数
memory_in_mb	String		虚拟机内存大小
guest_os_type	String		客户机操作系统
uuid	String		虚机uuid
support_agent	String		cas是否支持代理模式： 0：不支持 1：支持	0
rule	Object		虚机已存在的规则
rule_name	String		规则名称
rule_type	String		规则类型： 虚机复制：rep 虚机迁移：move 虚机备份：backup
status	String		规则状态	UNKNOW
user_uuid	String		规则创建者user_uuid
username	String		规则创建者username
region_id	String		区域ID
project_id	String		项目ID

获取不带层级结构的虚机列表

SDK方法名：listVmNoHierarchy

URL

/vp/platform/:uuid([A-F0-9-]+)/vm_list

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
search_name	String		搜索内容（名称/ip）
force_rpc	String		是否强制刷新，1是，0否

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功
vm_list	Array
morval	String			976
size	String
name	String			Fedora 64bit_crosscompile
time	String
exist_rule_type	String			@int(0,3)
host_ip	String			172.20.67.91
is_dir	String			0
cpu	String			1
core_per_sock	String			1
mem_mb	String			2048
os_type	Number			1
power_state	Number			1
type	String			VirtualMachine
support_cbt	String
uuid	String
networks	Array
network_id	String			HaNetwork-I2 Isolated VM Network
network_name	String			I2 Isolated VM Network
mac_address	String			00:50:56:98:b2:e4
ip	String			172.20.16.77,fe80::4fe2:de0d:fa55:f3fc

虚拟平台 - 查 单个虚机的详细信息

SDK方法名：getVmInfo;

URL

/vp/platform/vm_info

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
vp_uuid	String		虚拟平台uuid
vm_id	String		虚机id
region_id	String		区域ID
project_id	String		项目ID

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功
info	Object
mem_mb	String		内存	1024
cpu	String		cpu	8
core_per_sock	String		核心数	8
flavor_id	String
os_version	String		FC，源机os_version
networks	Array		网卡列表
network_id	String
network_name	String
mac_address	String
disks	Array		磁盘列表
size	String
id	String
disk_name	String
disk_dir	String
datastore	String
boot_index	String

虚拟平台 - 查 平台属性

URL中参数：vp_uuid

SDK方法名：describeVpAttribute

URL

/vp/platform/:uuid([A-F0-9-]+)/info

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否	@mock=200, http code	200
msg	String	否	错误信息
data	Object	否
message	String	否	错误信息提示
code	Number	否	@mock=0	0
api_version	String	否	API版本，如6.0	5.5
ip	String	否	虚拟平台IP	@ip
api_type	String	否	API类型，如HostAgent	HostAgent

虚拟平台 - 查 备机上备份列表（RC）1

SDK方法名：listBakVer；URL中参数：vp_uuid；

URL

/vp/platform/:uuid([A-F0-9-]+)/bak_ver

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rule_uuid	String		优先使用rule_uuid。 如果为空，则下方字段必传
bk_uuid	String	否	备机节点uuid	67E33CDB-D75B-15B3-367D-50C764F5A26F
bk_path	String	否	路径（文件系统传）	H:\vp_bk5\test2_BAK_vm-11880_192.168.88.22\
sto_uuid	String		对象存储uuid（对象存储传）
bucket	String		对象桶（name）（对象存储传）
bucket_path	String		桶路径（对象存储传）

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
data	Object	否
list	Array	否			2
size	Number	否		18446744073709551493
time	String	否	备份时间点	2018-09-04_14-26-22
backup_rule_uuid	String	否	备份点uuid	@guid()
is_root	String	否
data_type	String	否	备份数据类型：o:全备，i:增量，d:差异，f:整盘，n:获取类型失败
orch_result	Number		备份点是否演练，0 表示演练过，并且成功；1表示演练过并且失败。 空值表示未验证
can_del	Boolean		为true时，可以删除； 为false时，按钮置灰，不可删除
inuse_rules	Array		显示当前使用此备份点的规则
rule_name	String		规则名称
code	Number	否		0
message	String	否
vp_type	Number	否
instant_recovery	Number	否
bk_path	String		备份路径
msg	String	否

虚拟平台 - 查 备份点信息（RC）2

获取备份点信息；URL中参数：vp_uuid；

返回字段详细说明参考：https://apiref.info2soft.com/organization/repository/editor?id=22&mod=102&itf=671；

SDK方法名：listBakVerInfo

URL

/vp/platform/:uuid([A-F0-9-]+)/bak_ver_info

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
bk_uuid	String	否	（*必填）备机ID	67E33CDB-D75B-15B3-367D-50C764F5A26F
bk_path	String	否	（备份存储为文件系统时必填）备机规则备份路径	H:\vp_bk5\testRC1_BAK_99_192.168.85.139
sto_uuid	String		(备份存储为对象存储时必填)对象存储uuid
bucket	String		(备份存储为对象存储时必填) 对象桶（name）
bucket_path	String		(备份存储为对象存储时必填) 桶路径
group_uuid	String	否	可选，获取组时必传，用来获取组，备份规则group_uuid，获取此组下所有vm的list
time	String	否	可选，获取单个时必传，用来获取单个，用户选择的时间点，格式 2018-10-25_16-08-12	2019-01-07_13-10-45
ver_sig	String	否	可选，获取单个时必传，用来获取单个，配置信息ID；备份列表返回的 backup_rule_uuid	A59DB76E-E33D-4E22-BB08-59723B1FC539

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		11113561
message	String	否		[11113561] 无法读取该文件，请检查路径是否正确；
success_list	Array	否
ver_sig	String	否
time	String	否
bk_path	String	否
vm_name	String	否
vm_id	String	否
alt_name	String	否
annotation	String	否
vm_version	String	否
guest_os_id	String	否
num_cpus	Number	否		1
core_per_sock	Number	否		1
memory_mb	Number	否		1
host_name	String	否
datacenter	String	否
datastore	String	否
cpu_virtualization	Boolean	否		0
cpu_hot_add	Boolean	否		0
memory_hot_add	Number	否		0
firmware	String	否
disk_list	Array	否
id	String	否
disk_path	String	否
disk_name	String	否
total	String	否
format	String		磁盘格式	qcow2
boot_index	String		启动顺序	0
controllers	Array	否
dev_type	Number	否		1
key	Number	否		1
cKey	Number	否		1
unit_num	Number	否		1
type	Number	否		1
share	String	否		noSharing
hot_add_remove	Boolean	否		0
bus_num	Number	否		1
disks	Array	否
dev_type	Number	否		2
file_name	String	否		[datastore1] mini0-12-30_move/mini01-000001.vmdk
mode	String	否		persistent
type	Number	否		1
size_mb	Number	否		1
key	Number	否		1
c_key	Number	否		1
unit_num	Number	否		1
change_id	String	否
thin	Boolean	否		0
eager_thick	Boolean	否		0
format	String		磁盘格式	qcow2
boot_index	String		启动顺序	0
cdroms	Array	否
dev_type	Number	否		4
dev_name	String	否		Cdrom
type	Number	否		1
key	Number	否		1
c_key	Number	否		1
unit_num	Number	否		1
floppys	Array	否
dev_type	Number	否		5
type	Number	否		1
key	Number	否		1
c_key	Number	否		1
unit_num	Number	否		1
dev_name	String	否
nics	Array	否
dev_type	Number	否		3
mac_address	String	否
network_type	Number	否		1
network_key	Number	否		1
network_ctrl_key	Number	否		1
unit_num	Number	否		1
adapter_type	Number	否		1
network_name	String	否
network_id	String	否
os_type	Number		源机操作系统类型,0,linux;1,windows
trans_type	String		'ftp', 'scp'	cas备份点传输类型
encrypt_type	Number		备端数据加密方式 0：不加密， 1：aes， 2：sm4
backup_method	Number		cas备份方式： 0：基于平台接口； 1：基于平台主机代理	0
instant_recovery	Number		是否支持瞬时恢复 0：不支持 1：支持	0
fail_list	Array	否
code	Number	否		11113561
message	String	否		[11113561] 无法读取该文件，请检查路径是否正确；
vmName	String	否
vmId	String	否
info	Object	否
ver_sig	String	否
time	String	否
bk_path	String	否
vm_name	String	否
vm_id	String	否
alt_name	String	否
annotation	String	否
vm_version	String	否
guest_os_id	String	否
num_cpus	Number	否		1
core_per_sock	Number	否		1
memory_mb	Number	否		1
host_name	String	否
data_center	String	否
data_store	String	否
cpu_virtualization	Boolean	否		0
cpu_hot_add	Boolean	否		0
memory_hot_add	Number	否		0
firmware	String	否
disk_list	Array	否
id	String	否
disk_path	String	否
disk_name	String	否
total	String	否
format	String		磁盘格式	qcow2
boot_index	String		启动顺序	0
controllers	Array	否
dev_type	Number	否		1
key	Number	否		1
cKey	Number	否		1
unit_num	Number	否		1
type	Number	否		1
share	String	否		noSharing
hot_add_remove	Boolean	否		0
bus_num	Number	否		1
disks	Array	否
dev_type	Number	否		2
file_name	String	否		[datastore1] mini0-12-30_move/mini01-000001.vmdk
mode	String	否		persistent
type	Number	否		1
size_mb	Number	否		1
key	Number	否		1
c_key	Number	否		1
unit_num	Number	否		1
change_id	String	否
thin	Boolean	否		0
eager_thick	Boolean	否		0
format	String		磁盘格式	qcow2
boot_index	String		启动顺序	0
cdroms	Array	否
dev_type	Number	否		4
dev_name	String	否		Cdrom
type	Number	否		1
key	Number	否		1
c_key	Number	否		1
unit_num	Number	否		1
floppys	Array	否
dev_type	Number	否		5
type	Number	否		1
key	Number	否		1
c_key	Number	否		1
unit_num	Number	否		1
dev_name	String	否
nics	Array	否
dev_type	Number	否		3
mac_address	String	否
network_type	Number	否		1
network_key	Number	否		1
network_ctrl_key	Number	否		1
unit_num	Number	否		1
adapter_type	Number	否		1
network_name	String	否
network_id	String	否
os_type	Number
trans_type	String		'ftp', 'scp'
encrypt_type	Number		备端数据加密方式 0：不加密， 1：aes， 2：sm4
backup_method	Number		cas备份方式： 0：基于平台接口； 1：基于平台主机代理	0
instant_recovery	Number		是否支持瞬时恢复 0：不支持 1：支持	0

虚拟平台 - 查 数据存储下文件列表（RC）3

对应页面：工作目录；URL中参数：vp_uuid

SDK方法名：listDatastoreFile

URL

/vp/platform/:uuid([A-F0-9-]+)/datastore_file

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
dir_file	String	否	文件路径（"/"：查询根目录所有文件），传空返回/	/
ds_name	String	否	（*必填）数据存储名称	datastore107（1）
dc_name	String	否	（*必填）数据中心名称	ha-datacenter

Response

名称	类型	必选	简介	Mock初始值	Mock规则
data	Object	否
message	String	否	错误信息提示
code	Number	否		0
list	Array	否			2
path	String	否	文件路径	/temp
name	String	否	文件名称	Datacenter_@int(10,50)
msg	String	否	错误信息
ret	Number	否	@mock=200, http code	200

虚拟平台 - 查 数据中心列表（MOVE/REP）1

获取数据中心列表，dcmor 数据中心标识再此npsvr 中返回

SDK方法名：listDatacenter；URL中参数：vp_uuid；

URL

/vp/platform/:uuid([A-F0-9-]+)/datacenter

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否
list	Array	否
dc_mor	String	否	数据中心标识	@guid()
dc_name	String	否	数据中心	@name

虚拟平台 - 查 数据中心主机列表 （MOVE/REP）2

通过数据中心获取主机列表

SDK方法名：listDatacenterHost；URL中参数：vp_uuid；

URL

/vp/platform/:uuid([A-F0-9-]+)/datacenter_host

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
dc_name	String	否	可选，VMware传, 数据中心	ha-datacenter
dc_mor	String	否	可选，VMware传, 数据中心标识	ha-datacenter

Response

名称	类型	必选	简介	Mock初始值	Mock规则
data	Object	否
list	Array	否	主机列表，如"list":["localhost.localdomain"]	['@name']
message	String	否	, 错误信息提示
code	Number	否	@mock=0	0
msg	String	否	, 错误信息
ret	Number	否	@mock=200, http code	200

虚拟平台 - 查 存储列表 （MOVE/REP/RC）3

根据主机名称获取存储信息

SDK方法名：listDatastore；URL中参数：vp_uuid；

URL

/vp/platform/:uuid([A-F0-9-]+)/datastore

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
host_name	String	否	未传scope时必传，主机名	dev-esxi.6.6.6
path	String	否	可选，Hyper-V 传，首次传 /	/
scope	String		[Fusion Compute] （选填）存储所在的域 可以是站点/集群/主机ID

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String	否
data	Object	否
code	Number	否		0
message	String	否
list	Array	否	VMware数据存储列表
name	String	否	存储名称
total	String	否	总大小
free	String	否	可用空间
type	String	否	存储类型
dir_list	Array	否	Hyper-V, 数据存储列表
name	String	否	分区名称	@word
volume_total_size	String	否	分区容量	@integer(100)
volume_free_size	String	否	分区剩余容量	@integer(100)
ret	Number	否		200

虚拟平台 - 查 存储信息 （MOVE/REP/RC）4

通过存储名称获取存储信息

SDK方法名：listDatastoreInfo；URL中参数：vp_uuid；

URL

/vp/platform/:uuid([A-F0-9-]+)/datastore_info

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
ds_name	String	否	, 存储名称	datastore107（1）

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
message	String	否
total	String	否	总共大小	924,00
store_type	String	否	存储类型	VMFS
code	Number	否		0
free	String	否	剩余空间大小	21.00

虚拟平台 - 创建存储目录

SDK方法名：createDatastore；

URL

/vp/platform/:uuid([A-F0-9-]+)/datastore

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
host_name	String	否	主机名称	dev-esxi.6.6.6
path	String	否	需要创建的目录路径。如果是HyperV平台，则为一般的windows目录路径，如C:\abc\。如果是vmware平台，则需要带上数据存储，如 [datastore1] vmname/newfolder。	C:\abc\

Response

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

虚拟平台 - 查 虚机磁盘

通过虚机ID获取虚机上的磁盘列表，URL中参数：vp_uuid；

SDK方法名：listVmDisk；

URL

/vp/platform/:uuid([A-F0-9-]+)/vm_disk

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
vm_ref	String	否	虚机ID	vm-1376
region_id	String		区域ID
project_id	String		项目ID

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否
list	Array	否
id	String	否	uuid
disk_dir	String	否	磁盘所在目录。	/测试11_临时测试11/
disk_name	String	否	切下来的磁盘名称	测试11_临时测试11_5-000002.vmdk
size	String	否	格式化后的大小	2GB
datastore	String		磁盘所在的存储，只在vmware平台上有，其他平台为空。
boot_index	Number		磁盘启动顺序，openstack、hcs下0：启动盘；1或者其他数字表示非启动盘。vmware，cas，hyperv平台，因为npsvr无法判断磁盘是否为启动盘，所以由页面按磁盘顺序依次递增。	0
datastore_type	String		存储类型。 * local : 本地硬盘 * san: san存储 * advanceSan: advanceSan存储 * DSWARE: Fusion Storage Block * NAS: NAS存储 * LOCALPOME: 虚拟化本地硬盘 * LUNPOME: 虚拟化san存储 * LUN: 裸设备共享存储 * iotailor: 本地内存盘

虚拟平台 - 查 平台网卡

URL中参数：vp_uuid；

SDK方法名：listNetwork；

URL

/vp/platform/:uuid([A-F0-9-]+)/network

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
host_name	String	否	(选填) host名称

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否
list	Array	否
network_name	String	否
network_id	String	否

虚拟平台 - 演练配置

SDK方法名：drilConfigInfo；

URL

/vp/platform/drill_config

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
config_addr	String	否	管理地址
config_port	Number	否	管理地址通讯端口
vp_addr	String	否	虚拟平台IP
vp_type	String	否	平台类型 0:VMware 1:Hyper-V 2:FusionSphere ... 响应内容
use_credential	String	否
cred_uuid	String	否
os_usr	String	否
os_pwd	String	否	(RSA加密)
vp_uuid	String		虚拟平台uuid，新建时传null

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否
datacenters	Array	否
dcmor	String	否
dcname	String	否
hosts	Array	否
name	String	否
hostId	String	否
datastores	Array	否
name	String	否
type	String	否
total	String	否
free	String	否
networks	Array	否
network_name	String	否
network_id	String	否
orch_networks	Array
orch_network_name	String		隔离网卡信息名称
orch_network_id	String		隔离网卡id

虚拟平台 -导入虚机 IP映射，模板下载

SDK方法名：dl

URL

/dl

Method

GET

Request

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

Response

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

虚拟平台 - 导入虚机 IP映射

SDK方法名：importVmIpMapping；

URL

/vp/platform/batch_vm_ip_mapping

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
vp_uuid	String	否	虚拟平台uuid

Response

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

虚拟平台 - 获取虚机网卡信息列表

SDK方法名：listNetworkInfo；

URL

/vp/platform/network_info_list

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
vp_uuid	String	否	虚拟平台uuid
vm_ids	Array	否	所要查询的虚机的id
region_id	String
project_id	String

Response

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

虚拟平台 - 获取指定操作系统的信息

URL

/vp/platform/os_version

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
vp_uuid	String		（*必填）虚拟平台ID
os_versions	Array		被查询机器的os_version

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	String
message	String
data	Object
message	String
code	String
list	Array
os_version	String		操作系统版本标识
cpu_quantity_limit	String		该操作系统支持的最大CPU核数
cpu_socket_limit	String		该操作系统支持的最大CPU插槽数
mem_quantity_limit	String		该操作系统支持的最大内存容量，单位为MB

获取 虚机复制/整机备份 目标机状态信息

SDK方法名：tgtVmStatusInfo；

URL

/vp/platform/tgt_vm_status

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rule_uuids	String		规则uuid数组

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
data	Object
message	String
code	Number			0
status	Array
rule_uuid	String		规则uuid
status	String		目标机状态ONLINE, OFFLINE
code	String
state	String
name	String		虚机名称
morval	String		托管对象ID
power_state	String		虚机状态 -1：查询失败 1：开机状态 4：挂起状态 5：关机状态
cpu_num	String
cores_per_cpu	String
memory	String
hostip	String
rule_status	String		规则状态
ret	Number			200

添加演练配置（废弃）

URL

/vp/platform/drill

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
vp_uuid	String	是	虚拟平台ID
config	Object	是
proxy_name	String	是	代理网关名称
proxy_ip	String	是	代理网关ip
proxy_mask	String	是	代理网关子网掩码
proxy_gw	String	是	代理网关的网关
new_hostname	String	是	主机名
new_ds	String	是	数据存储
new_dc	String	是	数据中心
new_dc_mor	String	是	数据中心托管对象值
network_id	String	是	代理网关id
network_name	String	是	代理网关名称

Response

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

获取演练配置(废弃)

URL

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

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功
vp_drill_platform	Object	否
vp_uuid	String	否		1663DD96-C9BE-B49E-6044-3AB3120F4B74
vp_name	String	否		88.107
vp_type	Number	否		0
vp_addr	String	否		192.168.88.107
config_addr	String	否		192.168.72.75
config_port	String	否		58083
os_usr	String	否		root
os_pwd	String	否		12345678
comment	String	否
create_time	String	否		1533871285
random_str	String	否		AB790B28-62D6-7236-612F-65D73C80036F
user_uuid	String	否		1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
username	String	否		admin
lab_uuid	String	否
config	Object	否
network_id	String	否
network_name	String	否
new_dc	String	否
new_dc_mor	String	否
new_ds	String	否
new_hostname	String	否
proxy_name	String	否
proxy_ip	String	否
proxy_mask	String	否
proxy_gw	String	否

演练平台 - 获取列表（废弃）

URL

/vp/drill_plat

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功
total	Number	否		3
info_list	Array	否
vp_uuid	String	否		1663DD96-C9BE-B49E-6044-3AB3120F4B74
vp_name	String	否		88.107
vp_type	Number	否		0
vp_addr	String	否		192.168.88.107
user_uuid	String	否		1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
username	String	否		admin
lab_name	String	否
lab_uuid	String	否
config	Object	否
proxy_name	String	否
proxy_ip	String	否
proxy_mask	String	否
proxy_gw	String	否
npsvr_vip	String	否
npsvr_vmask	String	否
npsvr_vgw	String	否
product_ip	String	否
product_mask	String	否
product_gw	String	否
isolate_ip	String	否
isolate_mask	String	否
isolate_gw	String	否
new_hostname	String	否
new_ds	String	否
new_dc	String	否

演练平台 - 状态（废弃）

URL

/vp/drill_plat/status

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
lab_uuids	Array	否	lab_uuid 数组	["11111111-1111-1111-1111-111111111111"]

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功
status	Array	否
lab_uuid	String	否		4Ce6Bc6d-B84F-AfBC-39cA-F77fe5dcA1Be
status	String	否	DEPLOYED：部署完成；STALE：失效；DEPLOYING：部署中；

删除演练配置(废弃)

URL

/vp/platform/drill

Method

DELETE

Request

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

Response

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

------ 虚拟平台存储 ------

URL

/dash/vp_storage

Method

GET

Request

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

Response

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

单个平台存储列表

SDK方法名：listPlatformStorage;

URL

/vp/storage/platform_storage_list

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
vp_uuid	String		虚拟平台uuid	FC151595-EB90-86F5-B659-CA787753CA5D

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
total	Number			1
info_list	Array
uuid	String		存储uuid	FC151595-EB90-86F5-B659-CA787753CA5D
name	String		存储name	storage_name
type	String		存储类型	localfs
used	String		已使用容量(GB)	2
capacity	String		授权容量(GB)	10
enabled	Number		是否启用,1：是；0否；	1
message	String

修改存储授权容量、启用状态

SDK方法名：platformAuthorize;

URL

/vp/storage/platform_authorize

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
vp_uuid	String		虚拟平台uuid	DC151595-EB90-86F5-B659-CA787751CA5D
vp_storage	Array
uuid	String		存储uuid	FC151595-EB90-86F5-B659-CA787753CA5D
enabled	Number		启用状态,1：是；0；否	0
capacity	String		授权容量(GB)	10

Response

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

存储列表

SDK方法名：listVpStorage;

URL

/vp/storage

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
where_args['enabled']	String			1

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
total	Number			1
info_list	Array
uuid	String		存储uuid	C0744ABF-5571-8288-1930-439612B6234A
vp_uuid	String		虚拟平台uuid	C0744ABF-5571-8288-1930-439612B6234A
name	String		存储名称	storage
type	String		存储类型	localFs
path	String			/path
total	String		存储大小	102400
used	String		已使用容量byte	10240
create_time	String
storage_id	String			C0744ABF-5571-8288-1930-439612B6234A
message	String

通过ip和port，获取备份点列表

SDK方法名：listBakVerByIp

URL

/vp/platform/bk_ver_by_ip

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
config_addr	String		管理地址
config_port	String		管理端口
bk_uuid	String		备机uuid
bk_path	String		备份路径

Response

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

通过ip和port，获取备份点信息

SDK方法名：listBakVerInfoByIp

URL

/vp/platform/bk_ver_info_by_ip

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
config_addr	String		管理地址
config_port	String		管理端口
time	String		备份点时间
ver_sig	String		备份点id
bk_uuid	String
bk_path	String

Response

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

测试连接节点

SDK方法名：testNode

URL

/vp/platform/test_node

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
vp_uuid	String		备份：源平台uuid 恢复：目标平台uuid	6765E77A-C658-9AF1-83D0-1897B8A5850E
node_uuid	String		节点uuid	5765E77A-C658-9AF1-83D0-1897B8A5850E
cred_uuid	String		凭据uuid	4165E77A-C658-9AF1-83D0-1897B8A5850E
trans_type	String		FTP，SCP	FTP

Response

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

获取规则目标机信息

SDK方法名：getTargetVmInfo;

URL

/vp/platform/target_vm_info

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rule_uuids	Array		规则uuid
group_uuid	String		组uuid，组删除时可用
rule_type	String		规则类型： move：迁移； rep：复制； recovery：恢复； drill：演练；

Response

名称	类型	必选	简介	Mock初始值	Mock规则
data	Object
message	String
code	Number			10110035
list	Array
rule_uuid	String		规则uuid	C6335F62-2565-1957-4BB9-587F2FF46B00
rule_name	String		规则名称	''
name	String		目标虚机名称	''
status	String		UNKNOWN：未知； UP：运行中； HALT：挂起； DOWN：关机; EXCEPTION: 异常；	UNKNOWN
ret	Number			200
msg	String

获取平台卷类型列表

SDK方法名：listDiskType；

URL

/vp/platform/disk_type

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
vp_uuid	String
region_id	String		区域ID
project_id	String		项目ID

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
message	String
code	Number			10110035
disk_type	Array		卷类型列表

发现虚机

SDK方法名：discoveryVm;

URL

/vp/platform/discovery_vm

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
vp_uuid	String		虚拟平台uuid
match_policy	Object		匹配规则（同新建虚机备份）
vm_name	Array
type	String
value	String
location	Array
type	String
value	String
folder	Array
type	String
value	String
region_id	String		云平台 - 区域ID
project_id	String		云平台 - 项目ID

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功
list	Array
children	Array
name	String
type	Number			1
id	String
parent_id	String
summary	Object
name	String
mor_type	String
time	String
size	String
mor_value	String
host_ip	String
power_state	String
support_cbt	String
exist_rule_type	String
is_dir	String
cpu_num	String
cores_per_cpu	String
memory_in_mb	String
guest_os_type	String
uuid	String
support_agent	String			0
rule	Object
rule_name	String
rule_type	String
status	String			UNKNOW
user_uuid	String
username	String
is_dir	Number			0
morval	String
time	String
size	String
host_ip	String
power_state	String
support_cbt	String
exist_rule_type	String
cpu	String
core_per_sock	String
mem_mb	String
os_type	String
uuid	String
ip	String
support_agent	String
region_id	String
project_id	String

Winstack - 获取主机池列表

SDK方法名：listPools;

URL

/vp/platform/:uuid([A-F0-9-]+])/pool_list/

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
ret	Number			200
data	Object
message	String
code	Number			0
list	Array
pool_name	String		池名称
pool_id	String		池id

Winstack - 获取主机池主机列表

SDK方法名：listPoolHosts;

URL

/vp/platform/:uuid([A-F0-9-]+])/pool_host_list

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
message	String
code	Number			0
list	Array
host_name	String		主机名
host_id	String		主机id