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

裸金属管理

裸金属模板相关接口

添加预配置模板(AddPreconfigurationTemplate)

API请求

URLs

POST zstack/v1/baremetal/preconfigurations

Headers

Authorization: OAuth the-session-uuid

Body

{   "params": {     "name": "centos-7.2-minimal",     "description": "centos-7.2-minimal kickstart file",     "distribution": "centos7.2-x86_64",     "type": "kickstart",     "content": "..."   },   "systemTags": [],   "userTags": [] }

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X POST -d '{"params":{"name":"centos-7.2-minimal","description":"centos-7.2-minimal kickstart file","distribution":"centos7.2-x86_64","type":"kickstart","content":"..."}}' \ http://localhost:8080/zstack/v1/baremetal/preconfigurations

参数列表

名字	类型	位置	描述	可选值	起始版本
name	String	body(包含在`params`结构中)	资源名称		3.4.0
description (可选)	String	body(包含在`params`结构中)	资源的详细描述		3.4.0
distribution	String	body(包含在`params`结构中)	适用操作系统发行版		3.4.0
type	String	body(包含在`params`结构中)	模板类型	kickstart preseed autoyast	3.4.0
content	String	body(包含在`params`结构中)	模板内容		3.4.0
resourceUuid (可选)	String	body(包含在`params`结构中)	资源UUID		3.4.0
systemTags (可选)	List	body	系统标签		3.4.0
userTags (可选)	List	body	用户标签		3.4.0
tagUuids (可选)	List	body(包含在`params`结构中)	标签UUID列表		3.4.0

API返回

返回示例

{   "inventory": {     "uuid": "8d837ba978a4462eada4cd80f395617f",     "name": "centos_7_x86_64_mini_v1.cfg",     "description": "centos-7-minimal kickstart file",     "distribution": "centos-7-x86_64",     "type": "kickstart",     "content": "...",     "md5sum": "4448ac513c464e86aeb7eb75417c9345",     "isPredefined": false,     "state": "Enabled",     "createDate": "Aug 15, 2025 5:35:30 AM",     "lastOpDate": "Aug 15, 2025 5:35:30 AM"   } }

名字	类型	描述	起始版本
success	boolean		0.6
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	3.4.0
inventory	PreconfigurationTemplateInventory	详情参考inventory	3.4.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.4.0
name	String	资源名称	3.4.0
description	String	资源的详细描述	3.4.0
distribution	String	适用操作系统发行版	3.4.0
type	String	模板类型	3.4.0
content	String	模板内容	3.4.0
md5sum	String	模板MD5	3.4.0
isPredefined	Boolean	是否系统预置	3.4.0
state	String	状态	3.4.0
createDate	Timestamp	创建时间	3.4.0
lastOpDate	Timestamp	最后一次修改时间	3.4.0

SDK示例

Java SDK

AddPreconfigurationTemplateAction action = new AddPreconfigurationTemplateAction(); action.name = "centos-7.2-minimal"; action.description = "centos-7.2-minimal kickstart file"; action.distribution = "centos7.2-x86_64"; action.type = "kickstart"; action.content = "..."; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; AddPreconfigurationTemplateAction.Result res = action.call();

Python SDK

action = AddPreconfigurationTemplateAction() action.name = "centos-7.2-minimal" action.description = "centos-7.2-minimal kickstart file" action.distribution = "centos7.2-x86_64" action.type = "kickstart" action.content = "..." action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" res = action.call()

删除预配置模板(DeletePreconfigurationTemplate)

API请求

URLs

DELETE zstack/v1/baremetal/preconfigurations/{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/preconfigurations/a605200589a54c25962a351d2d7995ea?deleteMode=Permissive

参数列表

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

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

Python SDK

action = DeletePreconfigurationTemplateAction() action.uuid = "3a4fc05bf396447880dfd3fa4cf965b1" action.deleteMode = "Permissive" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" res = action.call()

修改预配置模板状态(ChangePreconfigurationTemplateState)

API请求

URLs

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

Headers

Authorization: OAuth the-session-uuid

Body

{   "changePreconfigurationTemplateState": {     "stateEvent": "disable"   },   "systemTags": [],   "userTags": [] }

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X PUT -d '{"changePreconfigurationTemplateState":{"stateEvent":"disable"}}' \ http://localhost:8080/zstack/v1/baremetal/preconfigurations/48e32bae102b30ccb921f582a33cee14/actions

参数列表

名字	类型	位置	描述	可选值	起始版本
uuid	String	url	资源的UUID，唯一标示该资源		3.4.0
stateEvent	String	body(包含在`changePreconfigurationTemplateState`结构中)	状态事件	enable disable	3.4.0
systemTags (可选)	List	body	系统标签		3.4.0
userTags (可选)	List	body	用户标签		3.4.0

API返回

返回示例

{   "inventory": {     "uuid": "edf8b9576a5d408fb135c20aa7dcefd3",     "name": "centos_7_x86_64_mini_v1.cfg",     "description": "centos-7-minimal kickstart file",     "distribution": "centos-7-x86_64",     "type": "kickstart",     "content": "...",     "md5sum": "f79f67ab6c3445029b187d14bf7e3b99",     "isPredefined": false,     "state": "Enabled",     "createDate": "Aug 15, 2025 5:33:55 AM",     "lastOpDate": "Aug 15, 2025 5:33:55 AM"   } }

名字	类型	描述	起始版本
success	boolean		0.6
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	3.4.0
inventory	PreconfigurationTemplateInventory	详情参考inventory	3.4.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.4.0
name	String	资源名称	3.4.0
description	String	资源的详细描述	3.4.0
distribution	String	适用操作系统发行版	3.4.0
type	String	模板类型	3.4.0
content	String	模板内容	3.4.0
md5sum	String	模板MD5	3.4.0
isPredefined	Boolean	是否系统预置	3.4.0
state	String	状态	3.4.0
createDate	Timestamp	创建时间	3.4.0
lastOpDate	Timestamp	最后一次修改时间	3.4.0

SDK示例

Java SDK

ChangePreconfigurationTemplateStateAction action = new ChangePreconfigurationTemplateStateAction(); action.uuid = "48e32bae102b30ccb921f582a33cee14"; action.stateEvent = "disable"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; ChangePreconfigurationTemplateStateAction.Result res = action.call();

Python SDK

action = ChangePreconfigurationTemplateStateAction() action.uuid = "48e32bae102b30ccb921f582a33cee14" action.stateEvent = "disable" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" res = action.call()

下一章:裸金属集群相关接口