获取虚拟机上的任务信息(GetVmTask)

API请求

URLs

GET zstack/v1/vm-instances/task-details

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/vm-instances/task-details

参数列表

名字	类型	位置	描述	起始版本
vmInstanceUuids	List	query		4.2.0
systemTags (可选)	List	query	系统标签	4.2.0
userTags (可选)	List	query	用户标签	4.2.0
syncSignatures (可选)	List	query		4.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

GetVmTaskAction action = new GetVmTaskAction();
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetVmTaskAction.Result res = action.call();

Python SDK

GetVmTaskAction action = GetVmTaskAction()
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetVmTaskAction.Result res = action.call()

上一篇获取内部依赖的分布式端口组或者镜像存储信息(GetInterdependentL3NetworksBackupStorages)下一篇获取虚拟机开机时间(GetVmUptime)