VM Related Interfaces

Delete VM

DELETE/zstack/v1/vm-instances/{uuid}

Delete a VM.

Headers

Authorization: OAuth the-session-uuid

Curl Example

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

Parameter List

NameTypeLocationDescriptionAllowed ValuesStarting Version
uuidStringurlVM UUID 0.6
deleteMode (optional)Stringbody  0.6
systemTags (optional)ListbodySystem tags 0.6
userTags (optional)ListbodyUser tags 0.6

API Response

This API returns an empty JSON structure {} on success. 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

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

Python SDK

DestroyVmInstanceAction action = DestroyVmInstanceAction()
action.uuid = "f7739013d2d5345ab5f59a728eac11a9"
action.deleteMode = "Permissive"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
DestroyVmInstanceAction.Result res = action.call()