VM Related Interfaces

Delete Virtual Machine Console Password

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

Delete the console password of a Virtual Machine.

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/ea4173dfb9673c6db6f13e86e442f502/console-password

Parameter List

NameTypeLocationDescriptionAllowed ValuesStarting Version
uuidStringurlVirtual Machine UUID 0.6
systemTags (Optional)ListbodySystem Tag 0.6
userTags (Optional)ListbodyUser Tag 0.6

API Response

Response Example

{
  "inventory": {
    "uuid": "df586d0d621836609ade6734dd4a45f1",
    "name": "Test-VM",
    "description": "web server VM",
    "zoneUuid": "792326bf6d4f314f9720d0bdc0da2ba6",
    "clusterUuid": "e304b625b055320e9680c8bc1ed096c4",
    "imageUuid": "28726d4ec39a356abf0d15fa006a5db3",
    "hostUuid": "7b50e9f1deb33299bef71631922518f5",
    "lastHostUuid": "33c8281f03a1336ea5e0af14546467aa",
    "instanceOfferingUuid": "bf454bc1e6363ed39bd490e0a17d7085",
    "rootVolumeUuid": "0889b134625933edbcf6c3626dc1ecb6",
    "platform": "Linux",
    "defaultL3NetworkUuid": "779c909b030e3d45b4c886c8d70c3d80",
    "type": "UserVm",
    "hypervisorType": "KVM",
    "memorySize": 8589934592,
    "cpuNum": 1,
    "allocatorStrategy": "LastHostPreferredAllocatorStrategy",
    "createDate": "Nov 14, 2017 10:20:57 PM",
    "lastOpDate": "Nov 14, 2017 10:20:57 PM",
    "state": "Running",
    "vmNics": [
      {
        "uuid": "5f6e0eccd83133f381ac93001f571b2a",
        "vmInstanceUuid": "df586d0d621836609ade6734dd4a45f1",
        "usedIpUuid": "fbc2d1acae463424a075562614b96f0d",
        "l3NetworkUuid": "779c909b030e3d45b4c886c8d70c3d80",
        "ip": "192.168.1.10",
        "mac": "00:0c:29:bd:99:fc",
        "hypervisorType": "KVM",
        "netmask": "255.255.255.0",
        "gateway": "192.168.1.1",
        "deviceId": 0,
        "state": "enable",
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ],
    "allVolumes": [
      {
        "uuid": "0889b134625933edbcf6c3626dc1ecb6",
        "name": "Root-Volume-For-VM-df586d0d621836609ade6734dd4a45f1",
        "primaryStorageUuid": "47ac865b823337f6b39e8cce0bcc3b6e",
        "vmInstanceUuid": "df586d0d621836609ade6734dd4a45f1",
        "diskOfferingUuid": "f3dda1b2937537038169109e8cfa19b2",
        "rootImageUuid": "28726d4ec39a356abf0d15fa006a5db3",
        "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-0889b134625933edbcf6c3626dc1ecb6/0889b134625933edbcf6c3626dc1ecb6.qcow2",
        "type": "Root",
        "format": "qcow2",
        "size": 107374182400,
        "actualSize": 21474836480,
        "deviceId": 0,
        "state": "Enabled",
        "status": "Ready",
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ]
  }
}
NameTypeDescriptionStarting Version
successboolean 0.6
errorErrorCodeError code. If not null, the operation failed. This field is null when the operation is successful. For details, see error0.6

error

NameTypeDescriptionStarting Version
codeStringError code number, a globally unique identifier for the error, for example SYS.1000, HOST.10010.6
descriptionStringBrief description of the error0.6
detailsStringDetailed error information0.6
elaborationStringReserved field, defaults to null0.6
opaqueLinkedHashMapReserved field, defaults to null0.6
causeErrorCodeRoot cause. The source error that caused the current error. If there is no original error, this field is null0.6

SDK Examples

Java SDK

DeleteVmConsolePasswordAction action = new DeleteVmConsolePasswordAction();
action.uuid = "ea4173dfb9673c6db6f13e86e442f502";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DeleteVmConsolePasswordAction.Result res = action.call();

Python SDK

DeleteVmConsolePasswordAction action = DeleteVmConsolePasswordAction()
action.uuid = "ea4173dfb9673c6db6f13e86e442f502"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
DeleteVmConsolePasswordAction.Result res = action.call()