裸金属管理(Plus)

ZStack Cloud 4.8.10>开发手册>资源中心>裸金属管理(Plus)

下载PDF

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

裸金属管理相关接口

创建裸机设备(CreateBaremetalChassis)

API请求

URLs

POST zstack/v1/baremetal/chassis

Headers

Authorization: OAuth the-session-uuid

Body

{   "params": {     "name": "test",     "clusterUuid": "bf598e729e61382ab2486ac40f25c425",     "ipmiAddress": "1.1.1.1",     "ipmiPort": "623.0",     "ipmiUsername": "root",     "ipmiPassword": "password"   },   "systemTags": [],   "userTags": [] }

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X POST -d '{"params":{"name":"test","clusterUuid":"bf598e729e61382ab2486ac40f25c425","ipmiAddress":"1.1.1.1","ipmiPort":"623.0","ipmiUsername":"root","ipmiPassword":"password"}}' http://localhost:8080/zstack/v1/baremetal/chassis

参数列表

名字	类型	位置	描述	起始版本
name	String	body(包含在params结构中)	资源名称	2.6.0
description (可选)	String	body(包含在params结构中)	资源的详细描述	2.6.0
clusterUuid	String	body(包含在params结构中)	集群UUID	2.6.0
ipmiAddress	String	body(包含在params结构中)	IPMI地址	2.6.0
ipmiPort (可选)	Integer	body(包含在params结构中)	IPMI端口	2.6.0
ipmiUsername	String	body(包含在params结构中)	IPMI用户名	2.6.0
ipmiPassword	String	body(包含在params结构中)	IPMI密码	2.6.0
resourceUuid (可选)	String	body(包含在params结构中)	资源UUID	2.6.0
systemTags (可选)	List	body	系统标签	2.6.0
userTags (可选)	List	body	用户标签	2.6.0

API返回

返回示例

{   "inventory": {     "uuid": "40fae70b4c573bdfad57d031eaba0eb0",     "ipmiAddress": "1.1.1.1",     "ipmiPort": 623.0,     "ipmiUsername": "root",     "ipmiPassword": "password",     "state": "Enabled",     "status": "HWInfoUnknown"   } }

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

#error

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

#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
ipmiAddress	String	IPMI地址	2.6.0
ipmiPort	Integer	IPMI端口	2.6.0
ipmiUsername	String	IPMI用户名	2.6.0
state	String		2.6.0
status	String		2.6.0
createDate	Timestamp	创建时间	2.6.0
lastOpDate	Timestamp	最后一次修改时间	2.6.0

SDK示例

Java SDK

CreateBaremetalChassisAction action = new CreateBaremetalChassisAction(); action.name = "test"; action.clusterUuid = "bf598e729e61382ab2486ac40f25c425"; action.ipmiAddress = "1.1.1.1"; action.ipmiPort = "623.0"; action.ipmiUsername = "root"; action.ipmiPassword = "password"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; CreateBaremetalChassisAction.Result res = action.call();

Python SDK

CreateBaremetalChassisAction action = CreateBaremetalChassisAction() action.name = "test" action.clusterUuid = "bf598e729e61382ab2486ac40f25c425" action.ipmiAddress = "1.1.1.1" action.ipmiPort = "623.0" action.ipmiUsername = "root" action.ipmiPassword = "password" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" CreateBaremetalChassisAction.Result res = action.call()

删除裸机设备(DeleteBaremetalChassis)

API请求

URLs

DELETE zstack/v1/baremetal/chassis/{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/chassis/b4962c6429d23e93b9473f5aee202496

参数列表

名字	类型	位置	描述	起始版本
uuid	String	url	资源的UUID，唯一标示该资源	2.6.0
deleteMode (可选)	String	body	删除模式	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

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

Python SDK

DeleteBaremetalChassisAction action = DeleteBaremetalChassisAction() action.uuid = "b4962c6429d23e93b9473f5aee202496" action.deleteMode = "Permissive" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" DeleteBaremetalChassisAction.Result res = action.call()