VM Related Interfaces

Get VM Task

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

Headers

Authorization: OAuth the-session-uuid

Curl Example

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

Parameter List

NameTypeLocationDescriptionAllowed ValuesStarting Version
vmInstanceUuidsListquery  4.2.0
systemTags (Optional)ListquerySystem Tag 4.2.0
userTags (Optional)ListqueryUser Tag 4.2.0
syncSignatures (Optional)Listquery  4.2.0

API Response

On success, this API returns an empty JSON structure {}. On error, the returned JSON structure contains an error field. For example:

{
  "error": {
    "code": "SYS.1001",
    "description": "A message or a operation timeout",
    "details": "Create VM on KVM timeout after 300s"
  }
}

SDK Examples

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()