裸金属主机相关接口

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

启动裸金属主机(StartBaremetalInstance)

API请求

URLs

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

Headers

Authorization: OAuth the-session-uuid

Body

{   "startBaremetalInstance": {     "pxeBoot": false   },   "systemTags": [],   "userTags": [] }

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X PUT -d '{"startBaremetalInstance":{"pxeBoot":false}}' \ http://localhost:8080/zstack/v1/baremetal/instances/dc6931adfb8a38bf9919d46b1531e9e4/actions

参数列表

名字	类型	位置	描述	起始版本
uuid	String	url	资源的UUID，唯一标示该资源	2.6.0
pxeBoot (可选)	Boolean	body(包含在`startBaremetalInstance`结构中)	是否通过网络PXE启动	2.6.0
systemTags (可选)	List	body	系统标签	2.6.0
userTags (可选)	List	body	用户标签	2.6.0

API返回

返回示例

{   "inventory": {     "uuid": "0be601277df73fa7bdb114b9ece8aec3",     "name": "BM-1",     "description": "This is a baremetal instance.",     "zoneUuid": "9b4745853c913a549499e39c2f8db6c7",     "clusterUuid": "21f709c6a9783fcb80803dece29a712a",     "chassisUuid": "4c3e24bc9218382c83ff81e9205fdc47",     "imageUuid": "e425f9323a4e3463b3a308c5ecca6653",     "platform": "Linux",     "state": "Running",     "status": "Provisioned",     "createDate": "Nov 14, 2017 2:20:57 PM",     "lastOpDate": "Nov 14, 2017 2:20:57 PM",     "bmNics": [       {         "uuid": "de7f5a22aa483de88bb3ede1c7dd071f",         "baremetalInstanceUuid": "0be601277df73fa7bdb114b9ece8aec3",         "l3NetworkUuid": "41ebe67163003dec94da84c6c5224037",         "mac": "6c:b3:11:1b:0b:1e",         "ip": "192.168.0.10",         "netmask": "255.255.255.0",         "gateway": "192.168.0.1",         "pxe": false       }     ]   } }

名字	类型	描述	起始版本
success	boolean		0.6
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	2.6.0
inventory	BaremetalInstanceInventory	详情参考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，唯一标示该资源	2.6.0
name	String	资源名称	2.6.0
description	String	资源的详细描述	2.6.0
zoneUuid	String	数据中心UUID	2.6.0
clusterUuid	String	集群UUID	2.6.0
pxeServerUuid	String		3.1.1
chassisUuid	String	裸机设备UUID	2.6.0
imageUuid	String	镜像UUID	2.6.0
platform	String	系统平台	2.6.0
state	String		2.6.0
status	String		2.6.0
createDate	Timestamp	创建时间	2.6.0
lastOpDate	Timestamp	最后一次修改时间	2.6.0
bmNics	List	详情参考bmNics	2.6.0

#bmNics

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	2.6.0
baremetalInstanceUuid	String	裸机实例UUID	2.6.0
l3NetworkUuid	String	分布式端口组UUID	2.6.0
baremetalBondingUuid	String	BOND UUID	3.4.0
mac	String	网卡MAC	2.6.0
ip	String	IP地址	2.6.0
netmask	String	子网掩码	2.6.0
gateway	String	网关	2.6.0
metadata	String		2.6.0
pxe	Boolean	是否PXE启动网卡	2.6.0
createDate	Timestamp	创建时间	2.6.0
lastOpDate	Timestamp	最后一次修改时间	2.6.0

SDK示例

Java SDK

StartBaremetalInstanceAction action = new StartBaremetalInstanceAction(); action.uuid = "dc6931adfb8a38bf9919d46b1531e9e4"; action.pxeBoot = false; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; StartBaremetalInstanceAction.Result res = action.call();

Python SDK

action = StartBaremetalInstanceAction() action.uuid = "dc6931adfb8a38bf9919d46b1531e9e4" action.pxeBoot = false action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" res = action.call()

删除裸金属主机(DestroyBaremetalInstance)

API请求

URLs

DELETE zstack/v1/baremetal/instances/{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/instances/8f34148a0cce3acf883c6f6b59eb8c0d?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

DestroyBaremetalInstanceAction action = new DestroyBaremetalInstanceAction(); action.uuid = "8f34148a0cce3acf883c6f6b59eb8c0d"; action.deleteMode = "Permissive"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; DestroyBaremetalInstanceAction.Result res = action.call();

Python SDK

action = DestroyBaremetalInstanceAction() action.uuid = "8f34148a0cce3acf883c6f6b59eb8c0d" action.deleteMode = "Permissive" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" res = action.call()

彻底删除裸金属主机(ExpungeBaremetalInstance)

API请求

URLs

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

Headers

Authorization: OAuth the-session-uuid

Body

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

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

Curl示例

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

参数列表

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

ExpungeBaremetalInstanceAction action = new ExpungeBaremetalInstanceAction(); action.uuid = "1016135ece1d3b189112cea52ae84d8d"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; ExpungeBaremetalInstanceAction.Result res = action.call();

Python SDK

action = ExpungeBaremetalInstanceAction() action.uuid = "1016135ece1d3b189112cea52ae84d8d" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" res = action.call()

下一章:裸金属网络相关接口