Pause Virtual Machine

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

Request

cURL

curl --request PUT \
  --url '/v1/vm-instances/{uuid}/actions' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "status": "ok",
  "method": "PUT",
  "path": "/v1/vm-instances/{uuid}/actions"
}

Pause a Virtual Machine. The Virtual Machine state remains in memory and can be resumed later.

Headers

Authorization: OAuth the-session-uuid

Body

{
  "pauseVmInstance": {},
  "systemTags": [],
  "userTags": []
}

The systemTags and userTags fields in the example above are optional. Listed to indicate these fields can be included in the body.

Curl Example

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

Parameter List

Name	Type	Location	Description	Starting Version
uuid	String	url	Virtual Machine UUID	0.6
systemTags (optional)	List	body	System Tags	0.6
userTags (optional)	List	body	User Tags	0.6

API Response

Return Example

{
  "inventory": {
    "uuid": "490ed95a1006364fb8ed3832d64ed119",
    "name": "Test-VM",
    "description": "web server VM",
    "zoneUuid": "1b6f8b5259a636cc9dc599fac936ca4a",
    "clusterUuid": "4ae4901e17f93e20b9a4c95a5546c90a",
    "imageUuid": "dd3deeda9faa38768d7bdd59fd10775b",
    "hostUuid": "3d8f04e1ea8a39cd96e0fd5a09ac8629",
    "lastHostUuid": "f57b7a0e6d5b3c53bb6048c47cb81fa0",
    "instanceOfferingUuid": "152010d532313e1d89bb91f50d1fd200",
    "rootVolumeUuid": "e18005eff51c353288cbf61d28261053",
    "platform": "Linux",
    "defaultL3NetworkUuid": "ba83a71ef20533309034e18c5b3b714c",
    "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": "8d33b79019d731fe901838aaf01e14f3",
        "vmInstanceUuid": "490ed95a1006364fb8ed3832d64ed119",
        "usedIpUuid": "ae18a8f6bd7e3d4d8cf2ecbbbc74edd7",
        "l3NetworkUuid": "ba83a71ef20533309034e18c5b3b714c",
        "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": "e18005eff51c353288cbf61d28261053",
        "name": "Root-Volume-For-VM-490ed95a1006364fb8ed3832d64ed119",
        "primaryStorageUuid": "ca53fd5c27eb352b9fefbcd8740a1334",
        "vmInstanceUuid": "490ed95a1006364fb8ed3832d64ed119",
        "diskOfferingUuid": "53f444b07ac83298be45d2bf3338cf10",
        "rootImageUuid": "dd3deeda9faa38768d7bdd59fd10775b",
        "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-e18005eff51c353288cbf61d28261053/e18005eff51c353288cbf61d28261053.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"
      }
    ]
  }
}

Name	Type	Description	Starting Version
success	boolean		0.6
error	ErrorCode	Error code. If not null, indicates operation failure. This field is null when the operation succeeds. See error	0.6
inventory	VmInstanceInventory	See inventory	0.6

error

Name	Type	Description	Starting Version
code	String	Error code number, a globally unique identifier for the error, for example SYS.1000, HOST.1001	0.6
description	String	Brief description of the error	0.6
details	String	Detailed error information	0.6
elaboration	String	Reserved field, defaults to null	0.6
opaque	LinkedHashMap	Reserved field, defaults to null	0.6
cause	ErrorCode	Root cause, the source error that triggered the current error. If there is no original error, this field is null	0.6

inventory

Name	Type	Description	Starting Version
uuid	String	Resource UUID, uniquely identifies the resource	0.6
name	String	Resource name	0.6
description	String	Detailed description of the resource	0.6
zoneUuid	String	Data Center UUID	0.6
clusterUuid	String	Cluster UUID	0.6
imageUuid	String	Image UUID	0.6
hostUuid	String	Host UUID	0.6
lastHostUuid	String		0.6
instanceOfferingUuid	String	Compute Offering UUID	0.6
rootVolumeUuid	String	Root Volume UUID	0.6
platform	String		0.6
architecture	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	Creation Time	0.6
lastOpDate	Timestamp	Last Operation Date	0.6
state	String		0.6
guestOsType	String		4.1.2
vmNics	List	See vmNics	0.6
allVolumes	List	See allVolumes	0.6
vmCdRoms	List	See vmCdRoms	0.6

vmNics

Name	Type	Description	Starting Version
uuid	String	Resource UUID, uniquely identifies the resource	0.6
vmInstanceUuid	String	Virtual Machine UUID	0.6
l3NetworkUuid	String	L3 Network UUID	0.6
ip	String		0.6
mac	String		0.6
hypervisorType	String		4.7.13
netmask	String		0.6
gateway	String		0.6
metaData	String		0.6
ipVersion	Integer	IP protocol version	3.1.0
driverType	String		4.7.13
internalName	String		4.7.13
deviceId	Integer		0.6
type	String		4.7.13
state	String	NIC status	4.7.13
createDate	Timestamp	Creation Time	0.6
lastOpDate	Timestamp	Last Operation Date	0.6
usedIps	List	See usedIps	0.6

usedIps

Name	Type	Description	Starting Version
uuid	String	Resource UUID, uniquely identifies the resource	0.6
ipRangeUuid	String	IP Range UUID	0.6
l3NetworkUuid	String	L3 Network UUID	0.6
ipVersion	Integer	IP Protocol Version	3.1.0
ip	String	IP Address	0.6
netmask	String	Network Mask	0.6
gateway	String	Gateway Address	0.6
usedFor	String		0.6
ipInLong	long		0.6
vmNicUuid	String	Virtual Machine NIC UUID	3.1.0
createDate	Timestamp	Creation Time	0.6
lastOpDate	Timestamp	Last Operation Date	0.6

allVolumes

Name	Type	Description	Starting Version
uuid	String	Resource UUID, uniquely identifies the resource	0.6
name	String	Resource name	0.6
description	String	Detailed description of the resource	0.6
primaryStorageUuid	String	Primary Storage UUID	0.6
vmInstanceUuid	String	Virtual Machine UUID	0.6
diskOfferingUuid	String	Disk Offering UUID	0.6
rootImageUuid	String	Root Image UUID	4.1.0
installPath	String	Volume path on primary storage	4.1.0
type	String	Volume type, data volume/root volume	4.1.0
format	String	Volume format	4.1.0
size	Long	Volume size	4.1.0
actualSize	Long	Actual volume size	4.1.0
deviceId	Integer		4.1.0
state	String	Whether the volume is enabled	4.1.0
status	String	Volume status	4.1.0
createDate	Timestamp	Creation Time	4.1.0
lastOpDate	Timestamp	Last Operation Date	4.1.0
isShareable	Boolean	Whether the volume is shareable	4.1.0
volumeQos	String	Volume QoS, format such as total=1048576	4.1.0
lastDetachDate	Timestamp		4.7.13
lastVmInstanceUuid	String		4.7.13

vmCdRoms

Name	Type	Description	Starting Version
uuid	String	Resource UUID, uniquely identifies the resource	4.7.13
vmInstanceUuid	String	Virtual Machine UUID	4.7.13
deviceId	Integer		4.7.13
isoUuid	String		4.7.13
isoInstallPath	String		4.7.13
name	String	Resource name	4.7.13
description	String	Detailed description of the resource	4.7.13
createDate	Timestamp	Creation Time	4.7.13
lastOpDate	Timestamp	Last Operation Date	4.7.13

SDK Examples

Java SDK

PauseVmInstanceAction action = new PauseVmInstanceAction();
action.uuid = "b7defb2dd07a38a8af7b98737a92080d";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
PauseVmInstanceAction.Result res = action.call();

Python SDK

action = PauseVmInstanceAction()
action.uuid = "b7defb2dd07a38a8af7b98737a92080d"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()