VMware管理(Plus)

ZStack Cloud 5.1.8>开发手册>资源中心>VMware管理(Plus)

下载PDF

VMware管理以单独的功能模块形式提供，需提前购买VMware管理模块许可证，且需在购买云平台许可证基础上使用，不可单独使用。

vCenter相关接口

添加vCenter资源(AddVCenter)

API请求

URLs

POST zstack/v1/vcenters

Headers

Authorization: OAuth the-session-uuid

Body

{   "params": {     "username": "admin@vsphere-local.net",     "password": "test-pass",     "zoneUuid": "25b9e68b1cc43836a79f1a35e3108880",     "name": "vc1",     "https": true,     "domainName": "vsphere-local.net"   },   "systemTags": [],   "userTags": [] }

说明: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X POST -d '{"params":{"username":"admin@vsphere-local.net","password":"test-pass","zoneUuid":"25b9e68b1cc43836a79f1a35e3108880","name":"vc1","https":true,"domainName":"vsphere-local.net"}}' \ http://localhost:8080/zstack/v1/vcenters

参数列表

名字	类型	位置	描述	起始版本
username	String	body(包含在params结构中)	登录 vCenter 用户名	0.6
password	String	body(包含在params结构中)	登录 vCenter 用户密码	0.6
zoneUuid	String	body(包含在params结构中)	vCenter 将要添加至的目标区域UUID	0.6
name	String	body(包含在params结构中)	vCenter 的名称	0.6
https (可选)	boolean	body(包含在params结构中)	是否启用 HTTPS 登录（默认开启）	0.6
domainName	String	body(包含在params结构中)	vCenter 域名	0.6
description (可选)	String	body(包含在params结构中)	vCenter 的详细描述	0.6
resourceUuid (可选)	String	body(包含在params结构中)	vCenter 的UUID。若指定，云主机会使用该字段值作为UUID。	0.6
systemTags (可选)	List	body	系统标签	0.6
userTags (可选)	List	body	用户标签	0.6
port (可选)	Integer	body(包含在`params`结构中)		0.6

API返回

返回示例

{   "inventory": {     "uuid": "1497ae9206ea3f82bb13c34c307299b9",     "name": "vc1",     "domainName": "vsphere-local.net",     "userName": "admin@vsphere-local.net",     "https": true,     "state": "Enabled",     "status": "Connected"   },   "skippedResources": {     "vmInstances": [       {         "uuid": "example",         "name": "exampleVm"       }     ]   } }

名字	类型	描述	起始版本
success	boolean		4.5.3
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	0.6
inventory	VCenterInventory	详情参考inventory	0.6
skippedResources	SkippedResources	详情参考skippedResources	4.5.3

#error

名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	0.6
description	String	错误的概要描述	0.6
details	String	错误的详细信息	0.6
elaboration	String	保留字段，默认为null	0.6
opaque	LinkedHashMap	保留字段，默认为null	0.6
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	0.6

#inventory

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	0.6
name	String	资源名称	0.6
description	String	资源的详细描述	0.6
domainName	String		0.6
port	Integer		0.6
userName	String		0.6
zoneUuid	String	区域UUID	0.6
https	Boolean		0.6
state	String		0.6
status	String		0.6
createDate	Timestamp	创建时间	0.6
lastOpDate	Timestamp	最后一次修改时间	0.6

#skippedResources

名字	类型	描述	起始版本
vmInstances	Set	详情参考vmInstances	4.5.3

#vmInstances

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	4.5.3
name	String	资源名称	4.5.3
description	String	资源的详细描述	4.5.3
zoneUuid	String	区域UUID	4.5.3
clusterUuid	String	集群UUID	4.5.3
imageUuid	String	镜像UUID	4.5.3
hostUuid	String	物理机UUID	4.5.3
lastHostUuid	String		4.5.3
instanceOfferingUuid	String	计算规格UUID	4.5.3
rootVolumeUuid	String	根云盘UUID	4.5.3
platform	String		4.5.3
architecture	String	架构类型	4.5.3
defaultL3NetworkUuid	String		4.5.3
type	String		4.5.3
hypervisorType	String		4.5.3
memorySize	Long		4.5.3
cpuNum	Integer		4.5.3
cpuSpeed	Long		4.5.3
allocatorStrategy	String		4.5.3
createDate	Timestamp	创建时间	4.5.3
lastOpDate	Timestamp	最后一次修改时间	4.5.3
state	String		4.5.3
guestOsType	String	操作系统类型	4.5.3
vmNics	List	详情参考vmNics	4.5.3
allVolumes	List	详情参考allVolumes	4.5.3
vmCdRoms	List	详情参考vmCdRoms	4.5.3

#vmNics

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	4.5.3
vmInstanceUuid	String	云主机UUID	4.5.3
l3NetworkUuid	String	三层网络UUID	4.5.3
ip	String	IP地址	4.5.3
mac	String	MAC地址	4.5.3
hypervisorType	String	虚拟化类型	4.5.3
netmask	String	子网掩码	4.5.3
gateway	String	网关	4.5.3
metaData	String		4.5.3
ipVersion	Integer	IP地址版本	4.5.3
deviceId	Integer	设备ID	4.5.3
type	String	网卡类型	4.5.3
createDate	Timestamp	创建时间	4.5.3
lastOpDate	Timestamp	最后一次修改时间	4.5.3
usedIps	List	详情参考usedIps	4.5.3

#usedIps

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	4.5.3
ipRangeUuid	String	IP段UUID	4.5.3
l3NetworkUuid	String	三层网络UUID	4.5.3
ipVersion	Integer	IP协议号	4.5.3
ip	String	IP地址	4.5.3
netmask	String	网络掩码	4.5.3
gateway	String	网关地址	4.5.3
usedFor	String		4.5.3
ipInLong	long		4.5.3
vmNicUuid	String	云主机网卡UUID	4.5.3
createDate	Timestamp	创建时间	4.5.3
lastOpDate	Timestamp	最后一次修改时间	4.5.3

#allVolumes

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	4.5.3
name	String	资源名称	4.5.3
description	String	资源的详细描述	4.5.3
primaryStorageUuid	String	主存储UUID	4.5.3
vmInstanceUuid	String	云主机UUID	4.5.3
diskOfferingUuid	String	云盘规格UUID	4.5.3
rootImageUuid	String	云盘根镜像UUID	4.5.3
installPath	String	云盘在主存储上的路径	4.5.3
type	String	云盘类型，数据云盘/根云盘	4.5.3
format	String	云盘格式	4.5.3
size	Long	云盘大小	4.5.3
actualSize	Long	云盘真实大小	4.5.3
deviceId	Integer		4.5.3
state	String	云盘是否开启	4.5.3
status	String	云盘状态	4.5.3
createDate	Timestamp	创建时间	4.5.3
lastOpDate	Timestamp	最后一次修改时间	4.5.3
isShareable	Boolean	是否共享云盘	4.5.3
volumeQos	String	云盘QoS，格式如total=1048576	4.5.3

#vmCdRoms

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	4.5.3
vmInstanceUuid	String	云主机UUID	4.5.3
deviceId	Integer	光驱顺序号	4.5.3
isoUuid	String	ISO镜像UUID	4.5.3
isoInstallPath	String	ISO镜像挂载路径	4.5.3
name	String	资源名称	4.5.3
description	String	资源的详细描述	4.5.3
createDate	Timestamp	创建时间	4.5.3
lastOpDate	Timestamp	最后一次修改时间	4.5.3

SDK示例

Java SDK

AddVCenterAction action = new AddVCenterAction(); action.username = "admin@vsphere-local.net"; action.password = "test-pass"; action.zoneUuid = "25b9e68b1cc43836a79f1a35e3108880"; action.name = "vc1"; action.https = true; action.domainName = "vsphere-local.net"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; AddVCenterAction.Result res = action.call();

Python SDK

AddVCenterAction action = AddVCenterAction() action.username = "admin@vsphere-local.net" action.password = "test-pass" action.zoneUuid = "25b9e68b1cc43836a79f1a35e3108880" action.name = "vc1" action.https = true action.domainName = "vsphere-local.net" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" AddVCenterAction.Result res = action.call()

查询vCenter资源(QueryVCenter)