StopVmInstance

API Request

URLs

PUT zstack/v1/vm-instances/{uuid}/actions

Headers

Authorization: OAuth the-session-uuid

Body

{
  "stopVmInstance": {
    "type": "grace"
  },
  "systemTags": [],
  "userTags": []
}

Note: In the preceding sample, both systemTags and userTags are optional. These two fields can be included in the body structure.

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"stopVmInstance":{"type":"grace"}}' \
http://localhost:8080/zstack/v1/vm-instances/5e2f112ee1ef3467933e1006b639b023/actions

Request Parameters


Name	Type	Location	Description	Optional Value	Starting Version
uuid	String	url	The VM instance UUID.		0.6
type	String	body (contained in the stopVmInstance structure)	Optional. The method to stop (shut down) the VM instance. Options: grace: graceful shutdown. To use this method, make sure that the corresponding ACPI driver is installed in the VM instance. cold: cold shutdown, which means to power off the VM instance directly.	grace cold	0.6
systemTags	List	body	Optional. The system tags.		0.6
userTags	List	body	Optional. The system tags.		0.6
stopHA	String	body (contained in the stopVmInstance structure)	Optional. Completely stops the HA VM instance.		2.2

API Response

Sample Response

{
  "inventory": {
    "uuid": "02b75a26397b347a8cf5cfaf5ce93ed1",
    "name": "Test-VM",
    "description": "web server VM",
    "zoneUuid": "2a9974ad7f7a343f908709094b509567",
    "clusterUuid": "e8626869bf793e0984bd4834c36582c4",
    "imageUuid": "7020002bfd163c9e8bf59e94b3948b3b",
    "hostUuid": "7cfc6cb3cb0d310281452e452f6fd8a5",
    "lastHostUuid": "e8b813355af136bdb5c34b1a760e52d4",
    "instanceOfferingUuid": "c8e4bc576e8633698b340ca572f45ae8",
    "rootVolumeUuid": "96b787ec9551331c907060238dff530f",
    "platform": "Linux",
    "defaultL3NetworkUuid": "6721d14d610037f193c17cb3b6f361b4",
    "type": "UserVm",
    "hypervisorType": "KVM",
    "memorySize": 8.589934592E9,
    "cpuNum": 1.0,
    "allocatorStrategy": "LastHostPreferredAllocatorStrategy",
    "createDate": "Nov 14, 2017 10:20:57 PM",
    "lastOpDate": "Nov 14, 2017 10:20:57 PM",
    "state": "Stopped",
    "vmNics": [
      {
        "uuid": "f13d9a01d5ff3953823f65f78bd94668",
        "vmInstanceUuid": "02b75a26397b347a8cf5cfaf5ce93ed1",
        "usedIpUuid": "9f7711d4a8b43c1ea582cedf98f44759",
        "l3NetworkUuid": "6721d14d610037f193c17cb3b6f361b4",
        "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.0,
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ],
    "allVolumes": [
      {
        "uuid": "96b787ec9551331c907060238dff530f",
        "name": "Root-Volume-For-VM-02b75a26397b347a8cf5cfaf5ce93ed1",
        "primaryStorageUuid": "d265ae8ea11d346cb0e657d46b6f2f86",
        "vmInstanceUuid": "02b75a26397b347a8cf5cfaf5ce93ed1",
        "diskOfferingUuid": "264dd6d637953cdda2ec0fc0c083a1fa",
        "rootImageUuid": "7020002bfd163c9e8bf59e94b3948b3b",
        "installPath": "/Cloud_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-96b787ec9551331c907060238dff530f/96b787ec9551331c907060238dff530f.qcow2",
        "type": "Root",
        "format": "qcow2",
        "size": 1.073741824E11,
        "actualSize": 2.147483648E10,
        "deviceId": 0.0,
        "state": "Enabled",
        "status": "Ready",
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ]
  }
}


Name	Type	Description	Starting Version
error	ErrorCode	The error code. If not null, the operation fails, or vice versa. For more information, see error.	0.6
inventory	VmInstanceInventory	See inventory.	0.6

#error


Name	Type	Description	Starting Version
code	String	The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.	0.6
description	String	The brief description of the error.	0.6
details	String	The details about the error.	0.6
elaboration	String	The reserved field. Default value: null.	0.6
opaque	LinkedHashMap	The reserved field. Default value: null.	0.6
cause	ErrorCode	The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.	0.6

#inventory


Name	Type	Description	Starting Version
uuid	String	The resource UUID.	0.6
name	String	The resource name.	0.6
description	String	The detailed description of the resource.	0.6
zoneUuid	String	The zone UUID.	0.6
clusterUuid	String	The cluster UUID.	0.6
imageUuid	String	The image UUID.	0.6
hostUuid	String	The host UUID.	0.6
lastHostUuid	String		0.6
instanceOfferingUuid	String	The instance offering UUID.	0.6
rootVolumeUuid	String	The root volume UUID.	0.6
platform	String		0.6
defaultL3NetworkUuid	String		0.6
type	String		0.6
hypervisorType	String		0.6
memorySize	Long		0.6
cpuNum	Integer		0.6
cpuSpeed	Long		0.6
allocatorStrategy	String		0.6
createDate	Timestamp	The creation date.	0.6
lastOpDate	Timestamp	The last operation date.	0.6
state	String		0.6
vmNics	List	See vmNics.	0.6
allVolumes	List	See allVolumes.	0.6

#vmNics


Name	Type	Description	Starting Version
uuid	String	The resource UUID.	0.6
vmInstanceUuid	String	The VM instance UUID.	0.6
l3NetworkUuid	String	The L3 network UUID.	0.6
ip	String		0.6
mac	String		0.6
netmask	String		0.6
gateway	String		0.6
metaData	String		0.6
ipVersion	Integer	The IP version.	3.1.0
deviceId	Integer		0.6
createDate	Timestamp	The creation date.	0.6
lastOpDate	Timestamp	The last operation date.	0.6
usedIps	List	See usedIps.	0.6

#usedIps


Name	Type	Description	Starting Version
uuid	String	The resource UUID.	0.6
ipRangeUuid	String	The IP range UUID.	0.6
l3NetworkUuid	String	The L3 network UUID.	0.6
ipVersion	Integer	The IP version.	3.1.0
ip	String	The IP address.	0.6
netmask	String	The netmask.	0.6
gateway	String	The gateway.	0.6
usedFor	String		0.6
ipInLong	long		0.6
vmNicUuid	String	The VM NIC UUID.	3.1.0
createDate	Timestamp	The creation date.	0.6
lastOpDate	Timestamp	The last operation date.	0.6

#allVolumes


Name	Type	Description	Starting Version
uuid	String	The resource UUID.	0.6
name	String	The resource name.	0.6
description	String	The detailed description of the resource.	0.6
primaryStorageUuid	String	The primary storage UUID.	0.6
vmInstanceUuid	String	The VM instance UUID.	0.6
diskOfferingUuid	String	The disk offering UUID.	0.6
rootImageUuid	String		0.6
installPath	String		0.6
type	String		0.6
format	String		0.6
size	Long		0.6
actualSize	Long		0.6
deviceId	Integer		0.6
state	String		0.6
status	String		0.6
createDate	Timestamp	The creation date.	0.6
lastOpDate	Timestamp	The last operation date.	0.6
isShareable	Boolean		0.6

SDK Sample

Java SDK

StopVmInstanceAction action = new StopVmInstanceAction();
action.uuid = "b3edccc737664a24b6b8be3a249b87fb";
action.type = "grace";
action.sessionId = "7f36a5bff7ae49c185302dca91470133";
StopVmInstanceAction.Result res = action.call();

Python SDK

StopVmInstanceAction action = StopVmInstanceAction()
action.uuid = "a6162b0be4104d069ab42f708d7da150"
action.type = "grace"
action.sessionId = "d369764a2e29479c9e70f86a3b4662e3"
StopVmInstanceAction.Result res = action.call()