裸金属集群相关接口

ZStack ZSphere产品文档>ZStack ZSphere 开发手册>裸金属管理>裸金属集群相关接口

创建PXE服务(CreateBaremetalPxeServer)

API请求

URLs

POST zstack/v1/baremetal/pxeservers

Headers

Authorization: OAuth the-session-uuid

Body

{   "params": {     "zoneUuid": "4d813a1e8053335d931094e4f41c0cad",     "name": "test",     "hostname": "127.0.0.1",     "sshUsername": "root",     "sshPassword": "password",     "sshPort": 22,     "storagePath": "/zstack_bm_cache",     "dhcpInterface": "eth0",     "dhcpRangeBegin": "10.0.0.1",     "dhcpRangeEnd": "10.0.0.255",     "dhcpRangeNetmask": "255.255.255.0"   },   "systemTags": [],   "userTags": [] }

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X POST -d '{"params":{"zoneUuid":"4d813a1e8053335d931094e4f41c0cad","name":"test","hostname":"127.0.0.1","sshUsername":"root","sshPassword":"password","sshPort":22,"storagePath":"/zstack_bm_cache","dhcpInterface":"eth0","dhcpRangeBegin":"10.0.0.1","dhcpRangeEnd":"10.0.0.255","dhcpRangeNetmask":"255.255.255.0"}}' \ http://localhost:8080/zstack/v1/baremetal/pxeservers

参数列表

名字	类型	位置	描述	起始版本
name	String	body(包含在`params`结构中)	资源名称	2.6.0
description (可选)	String	body(包含在`params`结构中)	资源的详细描述	2.6.0
dhcpInterface	String	body(包含在`params`结构中)	DHCP请求监听网卡	2.6.0
dhcpRangeBegin (可选)	String	body(包含在`params`结构中)	DHCP地址范围起始	2.6.0
dhcpRangeEnd (可选)	String	body(包含在`params`结构中)	DHCP地址范围终止	2.6.0
dhcpRangeNetmask (可选)	String	body(包含在`params`结构中)	DHCP地址范围掩码	2.6.0
systemTags (可选)	List	body	系统标签	2.6.0
userTags (可选)	List	body	用户标签	2.6.0
zoneUuid	String	body(包含在`params`结构中)	数据中心UUID	0.6
hostname	String	body(包含在`params`结构中)		0.6
sshUsername	String	body(包含在`params`结构中)		0.6
sshPassword	String	body(包含在`params`结构中)		0.6
sshPort (可选)	Integer	body(包含在`params`结构中)		0.6
storagePath	String	body(包含在`params`结构中)		0.6
resourceUuid (可选)	String	body(包含在`params`结构中)		0.6
tagUuids (可选)	List	body(包含在`params`结构中)	标签UUID列表	3.4.0

API返回

返回示例

{   "inventory": {     "uuid": "e958961c7785304691d49ec5ac7df64d",     "name": "test",     "hostname": "127.0.0.1",     "sshUsername": "root",     "sshPassword": "password",     "sshPort": 22,     "storagePath": "/zstack_bm_cache",     "dhcpInterface": "eth0",     "dhcpRangeBegin": "10.0.0.1",     "dhcpRangeEnd": "10.0.0.255",     "dhcpRangeNetmask": "255.255.255.0",     "state": "Enabled",     "status": "Connecting"   } }

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

#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，唯一标示该资源	3.1.1
zoneUuid	String	数据中心UUID	3.1.1
name	String	资源名称	3.1.1
description	String	资源的详细描述	3.1.1
hostname	String	部署服务器地址	3.1.1
sshUsername	String	部署服务器SSH账户	3.1.1
sshPassword	String	部署服务器SSH密码	3.1.1
sshPort	Integer	部署服务器SSH端口	3.1.1
storagePath	String	部署服务器存储路径	3.1.1
dhcpInterface	String	DHCP请求监听网卡	3.1.1
dhcpInterfaceAddress	String	DHCP请求监听网卡IP	3.1.1
dhcpRangeBegin	String	DHCP地址范围起始	3.1.1
dhcpRangeEnd	String	DHCP地址范围终止	3.1.1
dhcpRangeNetmask	String	DHCP子网掩码	3.1.1
state	String	部署服务器运行状态	3.1.1
status	String	部署服务器连接状态	3.1.1
createDate	Timestamp	创建时间	3.1.1
lastOpDate	Timestamp	最后一次修改时间	3.1.1
totalCapacity	Long	存储路径总容量	3.1.1
availableCapacity	Long	存储路径可用容量	3.1.1
attachedClusterUuids	List	部署服务器挂载集群UUID列表	3.1.1

SDK示例

Java SDK

CreateBaremetalPxeServerAction action = new CreateBaremetalPxeServerAction(); action.zoneUuid = "4d813a1e8053335d931094e4f41c0cad"; action.name = "test"; action.hostname = "127.0.0.1"; action.sshUsername = "root"; action.sshPassword = "password"; action.sshPort = 22; action.storagePath = "/zstack_bm_cache"; action.dhcpInterface = "eth0"; action.dhcpRangeBegin = "10.0.0.1"; action.dhcpRangeEnd = "10.0.0.255"; action.dhcpRangeNetmask = "255.255.255.0"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; CreateBaremetalPxeServerAction.Result res = action.call();

Python SDK

action = CreateBaremetalPxeServerAction() action.zoneUuid = "4d813a1e8053335d931094e4f41c0cad" action.name = "test" action.hostname = "127.0.0.1" action.sshUsername = "root" action.sshPassword = "password" action.sshPort = 22 action.storagePath = "/zstack_bm_cache" action.dhcpInterface = "eth0" action.dhcpRangeBegin = "10.0.0.1" action.dhcpRangeEnd = "10.0.0.255" action.dhcpRangeNetmask = "255.255.255.0" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" res = action.call()

删除PXE服务(DeleteBaremetalPxeServer)

API请求

URLs

DELETE zstack/v1/baremetal/pxeservers/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X DELETE http://localhost:8080/zstack/v1/baremetal/pxeservers/da517231390c368b91440d0bda783ba1?deleteMode=Permissive

参数列表

名字	类型	位置	描述	起始版本
uuid	String	url	资源的UUID，唯一标示该资源	2.6.0
deleteMode (可选)	String	query	删除模式	2.6.0
systemTags (可选)	List	query	系统标签	2.6.0
userTags (可选)	List	query	用户标签	2.6.0

API返回

该API成功时返回一个空的JSON结构{}，出错时返回的JSON结构包含一个error字段，例如：

{ 	"error": { 		"code": "SYS.1001", 		"description": "A message or a operation timeout", 		"details": "Create VM on KVM timeout after 300s" 	} }

SDK示例

Java SDK

DeleteBaremetalPxeServerAction action = new DeleteBaremetalPxeServerAction(); action.uuid = "da517231390c368b91440d0bda783ba1"; action.deleteMode = "Permissive"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; DeleteBaremetalPxeServerAction.Result res = action.call();

Python SDK

action = DeleteBaremetalPxeServerAction() action.uuid = "da517231390c368b91440d0bda783ba1" action.deleteMode = "Permissive" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" res = action.call()

启动PXE服务(StartBaremetalPxeServer)

API请求

URLs

PUT zstack/v1/baremetal/pxeservers/{uuid}/actions

Headers

Authorization: OAuth the-session-uuid

Body

{   "startBaremetalPxeServer": {},   "systemTags": [],   "userTags": [] }

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X PUT -d '{"startBaremetalPxeServer":{}}' \ http://localhost:8080/zstack/v1/baremetal/pxeservers/340b1f6b12ab305aa05c12ded00020e7/actions

参数列表

名字	类型	位置	描述	起始版本
uuid	String	url	资源的UUID，唯一标示该资源	2.6.0
systemTags (可选)	List	body	系统标签	2.6.0
userTags (可选)	List	body	用户标签	2.6.0

API返回

返回示例

{   "inventory": {     "uuid": "ac3a53373cfd328b8932bdd29f4886dd",     "name": "test",     "hostname": "127.0.0.1",     "sshUsername": "root",     "sshPassword": "password",     "sshPort": 22,     "storagePath": "/zstack_bm_cache",     "dhcpInterface": "eth0",     "dhcpRangeBegin": "10.0.0.1",     "dhcpRangeEnd": "10.0.0.255",     "dhcpRangeNetmask": "255.255.255.0",     "state": "Enabled",     "status": "Connected"   } }

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

#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

SDK示例

Java SDK

StartBaremetalPxeServerAction action = new StartBaremetalPxeServerAction(); action.uuid = "340b1f6b12ab305aa05c12ded00020e7"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; StartBaremetalPxeServerAction.Result res = action.call();

Python SDK

action = StartBaremetalPxeServerAction() action.uuid = "340b1f6b12ab305aa05c12ded00020e7" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" res = action.call()

下一章:裸金属设备相关接口