自动化运维

ZStack Cloud 5.3.0>ZStack CLoud开发手册>平台运维>自动化运维

脚本库相关接口

创建脚本 (CreateGuestVmScript)

API请求

URLs

POST zstack/v1/scripts

Headers

Authorization: OAuth the-session-uuid

Body

{   "params": {     "name": "script1",     "description": "this is a script",     "scriptContent": "ZWNobyBoZWxsb3dvcmxkCg\u003d\u003d",     "renderParams": "[{\"key\":\"key\",\"value\":\"value\",\"description\":\"description\"}]",     "platform": "Linux",     "scriptType": "Shell",     "scriptTimeout": 30   },   "systemTags": [],   "userTags": [] }

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X POST -d '{"params":{"name":"script1","description":"this is a script","scriptContent":"ZWNobyBoZWxsb3dvcmxkCg==","renderParams":"[{\"key\":\"key\",\"value\":\"value\",\"description\":\"description\"}]","platform":"Linux","scriptType":"Shell","scriptTimeout":30}}' http://localhost:8080/zstack/v1/scripts

参数列表

名字	类型	位置	描述	可选值	起始版本
name	String	body(包含在params结构中)	资源名称		5.2.0
description (可选)	String	body(包含在params结构中)	资源的详细描述		5.2.0
scriptContent	String	body(包含在params结构中)	脚本内容		5.2.0
renderParams (可选)	String	body(包含在params结构中)	参数		5.2.0
platform	String	body(包含在params结构中)	平台	Windows Linux	5.2.0
scriptType	String	body(包含在params结构中)	脚本类型	Shell Python Perl Bat Powershell	5.2.0
scriptTimeout (可选)	int	body(包含在params结构中)	超时时间		5.2.0
resourceUuid (可选)	String	body(包含在params结构中)	资源UUID		5.2.0
tagUuids (可选)	List	body(包含在params结构中)	标签UUID列表		5.2.0
systemTags (可选)	List	body	系统标签		5.2.0
userTags (可选)	List	body	用户标签		5.2.0

API返回

返回示例

{   "inventory": {     "uuid": "a90f02b86916371a87bb5f2716dbfc0c",     "name": "script1",     "description": "this is a script",     "scriptContent": "echo helloworld",     "renderParams": "[{\"key\":\"key\",\"value\":\"value\",\"description\":\"description\"}]",     "platform": "Linux",     "scriptType": "Shell",     "scriptTimeout": 30,     "createDate": "Sep 23, 2024 11:53:59 AM",     "lastOpDate": "Sep 23, 2024 11:53:59 AM"   } }

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

#error

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

#inventory

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	5.2.0
name	String	资源名称	5.2.0
description	String	资源的详细描述	5.2.0
scriptContent	String	脚本内容	5.2.0
renderParams	String	参数	5.2.0
platform	String	平台	5.2.0
scriptType	String	类型	5.2.0
scriptTimeout	Integer	超时时间	5.2.0
createDate	Timestamp	创建时间	5.2.0
lastOpDate	Timestamp	最后一次修改时间	5.2.0

SDK示例

Java SDK

CreateGuestVmScriptAction action = new CreateGuestVmScriptAction(); action.name = "script1"; action.description = "this is a script"; action.scriptContent = "ZWNobyBoZWxsb3dvcmxkCg=="; action.renderParams = "[{"key":"key","value":"value","description":"description"}]"; action.platform = "Linux"; action.scriptType = "Shell"; action.scriptTimeout = 30; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; CreateGuestVmScriptAction.Result res = action.call();

Python SDK

CreateGuestVmScriptAction action = CreateGuestVmScriptAction() action.name = "script1" action.description = "this is a script" action.scriptContent = "ZWNobyBoZWxsb3dvcmxkCg==" action.renderParams = "[{"key":"key","value":"value","description":"description"}]" action.platform = "Linux" action.scriptType = "Shell" action.scriptTimeout = 30 action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" CreateGuestVmScriptAction.Result res = action.call()

删除脚本 (DeleteGuestVmScript)

API请求

URLs

DELETE zstack/v1/scripts/{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/scripts/ed1ef717239e37c29163dcad7576b8d4

参数列表

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

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

Python SDK

DeleteGuestVmScriptAction action = DeleteGuestVmScriptAction() action.uuid = "ed1ef717239e37c29163dcad7576b8d4" action.deleteMode = "Permissive" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" DeleteGuestVmScriptAction.Result res = action.call()