StartVmInstance

API Request

URLs
PUT zstack/v1/vm-instances/{uuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
  "startVmInstance": {},
  "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 '{"startVmInstance":{}}' \
http://localhost:8080/zstack/v1/vm-instances/647db3dbf974372ead60d4ba1c9efac3/actions
Request Parameters
Name Type Location Description Optional Value Starting Version
uuid String url The VM instance UUID. 0.6
clusterUuid String body (contained in the startVmInstance structure) Optional. The cluster UUID. If specified, the VM instance will be started in the specified cluster. 0.6
hostUuid String body (contained in the startVmInstance structure) Optional. The host UUID. If specified, the VM instance will be started on the specified host. This parameter can override clusterUuid. 0.6
systemTags List body Optional. The system tags. 0.6
userTags List body Optional. The user tags. 0.6
Note:
  • When you start a VM instance in ZStack Cloud, the cloud records whether a VPC vRouter is added to an HA group. Note that you can add the haUuid option to SystemTags.
    • Format of the haUuid option: haUuid::HA_GROUP_UUID
    • Example: haUuid::e2af8f869eff49d2a3d6f86cadc27090

API Response

Sample Response
{
  "inventory": {
    "uuid": "4fe3f157d2ed3952a528f7a7ad66b458",
    "name": "Test-VM",
    "description": "web server VM",
    "zoneUuid": "05f33790e80833f09d1e41d5dcce1cdb",
    "clusterUuid": "ed1f4443dfe83da2a4682eea6a6ff8a4",
    "imageUuid": "9d708bf2d7793d41a8d6aa91ffd8c997",
    "hostUuid": "5822c13181e73c7e8542884ba85e9339",
    "lastHostUuid": "b3ead9d0161f3c228cc4d4663f4886a4",
    "instanceOfferingUuid": "2799e9b24b173e47b63d15ee1e37212d",
    "rootVolumeUuid": "53bd57a8d319373eb2e957bb34d10ad6",
    "platform": "Linux",
    "defaultL3NetworkUuid": "0ed1289e1a5f333f9defdec7a6fd5f74",
    "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": "Running",
    "vmNics": [
      {
        "uuid": "b2293d252de931be87ca1ac4379269e9",
        "vmInstanceUuid": "4fe3f157d2ed3952a528f7a7ad66b458",
        "usedIpUuid": "78c4d1ced5cb3d5f89dabf4798819ecc",
        "l3NetworkUuid": "0ed1289e1a5f333f9defdec7a6fd5f74",
        "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": "53bd57a8d319373eb2e957bb34d10ad6",
        "name": "Root-Volume-For-VM-4fe3f157d2ed3952a528f7a7ad66b458",
        "primaryStorageUuid": "6d34e188053e31efb36aeae392a6d92e",
        "vmInstanceUuid": "4fe3f157d2ed3952a528f7a7ad66b458",
        "diskOfferingUuid": "44980553f47e3bfe94674c2004a9ffe7",
        "rootImageUuid": "9d708bf2d7793d41a8d6aa91ffd8c997",
        "installPath": "/Cloud_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-53bd57a8d319373eb2e957bb34d10ad6/53bd57a8d319373eb2e957bb34d10ad6.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
StartVmInstanceAction action = new StartVmInstanceAction();
action.uuid = "22771459f2184f2f96c8da84b7e660d8";
action.sessionId = "a6beddb0aa754b4b992d92dc13ff0c2c";
StartVmInstanceAction.Result res = action.call();
Python SDK
StartVmInstanceAction action = StartVmInstanceAction()
action.uuid = "b2b7503e1fdd482594700cf35715122a"
action.sessionId = "207b50ceb1b64ea48a7446b92932d4cb"
StartVmInstanceAction.Result res = action.call()