云主机执行命令(ExecuteGuestVmCommand)

API请求

URLs

PUT zstack/v1/vm-instances/commands/exec

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "vmInstanceUuid": "af89f31332ac3457874450311affadc2",
    "platform": "Linux",
    "command": "echo helloworld",
    "commandTimeout": 20
  },
  "systemTags": [],
  "userTags": []
}

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"vmInstanceUuid":"af89f31332ac3457874450311affadc2","platform":"Linux","command":"echo helloworld","commandTimeout":20}}' http://localhost:8080/zstack/v1/vm-instances/commands/exec

参数列表

名字	类型	位置	描述	可选值	起始版本
vmInstanceUuid	String	body(包含在params结构中)	云主机UUID		5.2.0
platform	String	body(包含在params结构中)	平台	Windows Linux	5.2.0
command	String	body(包含在params结构中)	命令		5.2.0
commandTimeout (可选)	Integer	body(包含在params结构中)	超时时间		5.2.0
systemTags (可选)	List	body	系统标签		5.2.0
userTags (可选)	List	body	用户标签		5.2.0

API返回

返回示例

{
  "stream": "standardStream: hello world, errorStream: 1/0 is not a goodScript",
  "vmInstance": {
    "uuid": "fc022ba201c135d8809c5e02bf6bf156",
    "name": "vm_1"
  }
}

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

#inventory

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	5.2.0
name	String	资源名称	5.2.0
description	String	资源的详细描述	5.2.0
zoneUuid	String	区域UUID	5.2.0
clusterUuid	String	集群UUID	5.2.0
imageUuid	String	镜像UUID	5.2.0
hostUuid	String	物理机UUID	5.2.0
lastHostUuid	String		5.2.0
instanceOfferingUuid	String	计算规格UUID	5.2.0
rootVolumeUuid	String	根云盘UUID	5.2.0
platform	String		5.2.0
architecture	String		5.2.0
defaultL3NetworkUuid	String		5.2.0
type	String		5.2.0
hypervisorType	String		5.2.0
memorySize	Long		5.2.0
cpuNum	Integer		5.2.0
cpuSpeed	Long		5.2.0
allocatorStrategy	String		5.2.0
createDate	Timestamp	创建时间	5.2.0
lastOpDate	Timestamp	最后一次修改时间	5.2.0
state	String		5.2.0
guestOsType	String		5.2.0
vmNics	List	详情参考vmNics	5.2.0
allVolumes	List	详情参考allVolumes	5.2.0
vmCdRoms	List	详情参考vmCdRoms	5.2.0

#vmNics

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	5.2.0
vmInstanceUuid	String	云主机UUID	5.2.0
l3NetworkUuid	String	三层网络UUID	5.2.0
ip	String		5.2.0
mac	String		5.2.0
hypervisorType	String		5.2.0
netmask	String		5.2.0
gateway	String		5.2.0
metaData	String		5.2.0
ipVersion	Integer		5.2.0
driverType	String		5.2.0
internalName	String		5.2.0
deviceId	Integer		5.2.0
type	String		5.2.0
state	String	网卡状态	5.2.0
createDate	Timestamp	创建时间	5.2.0
lastOpDate	Timestamp	最后一次修改时间	5.2.0
usedIps	List	详情参考usedIps	5.2.0

#usedIps

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	5.2.0
ipRangeUuid	String	IP段UUID	5.2.0
l3NetworkUuid	String	三层网络UUID	5.2.0
ipVersion	Integer		5.2.0
ip	String		5.2.0
netmask	String		5.2.0
gateway	String		5.2.0
usedFor	String		5.2.0
ipInLong	long		5.2.0
vmNicUuid	String	云主机网卡UUID	5.2.0
createDate	Timestamp	创建时间	5.2.0
lastOpDate	Timestamp	最后一次修改时间	5.2.0

#allVolumes

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	5.2.0
name	String	资源名称	5.2.0
description	String	资源的详细描述	5.2.0
primaryStorageUuid	String	主存储UUID	5.2.0
vmInstanceUuid	String	云主机UUID	5.2.0
diskOfferingUuid	String	云盘规格UUID	5.2.0
rootImageUuid	String		5.2.0
installPath	String		5.2.0
type	String		5.2.0
format	String		5.2.0
size	Long		5.2.0
actualSize	Long		5.2.0
deviceId	Integer		5.2.0
state	String		5.2.0
status	String		5.2.0
createDate	Timestamp	创建时间	5.2.0
lastOpDate	Timestamp	最后一次修改时间	5.2.0
isShareable	Boolean		5.2.0
volumeQos	String		5.2.0
lastDetachDate	Timestamp		5.2.0
lastVmInstanceUuid	String		5.2.0

#vmCdRoms

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	5.2.0
vmInstanceUuid	String	云主机UUID	5.2.0
deviceId	Integer		5.2.0
isoUuid	String		5.2.0
isoInstallPath	String		5.2.0
name	String	资源名称	5.2.0
description	String	资源的详细描述	5.2.0
createDate	Timestamp	创建时间	5.2.0
lastOpDate	Timestamp	最后一次修改时间	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

SDK示例

Java SDK

ExecuteGuestVmCommandAction action = new ExecuteGuestVmCommandAction();
action.vmInstanceUuid = "af89f31332ac3457874450311affadc2";
action.platform = "Linux";
action.command = "echo helloworld";
action.commandTimeout = 20;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ExecuteGuestVmCommandAction.Result res = action.call();

Python SDK

ExecuteGuestVmCommandAction action = ExecuteGuestVmCommandAction()
action.vmInstanceUuid = "af89f31332ac3457874450311affadc2"
action.platform = "Linux"
action.command = "echo helloworld"
action.commandTimeout = 20
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ExecuteGuestVmCommandAction.Result res = action.call()

上一篇扁平合并云主机(FlattenVmInstance)下一篇发送文件到云主机(UploadFileToVm)