VM Related Interfaces
Detach ISO from VM
Headers
Authorization: OAuth the-session-uuidCurl Example
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth 402a9d5c22174d18b54daf3b989e1c59" \
-X DELETE http://localhost:8080/zstack/v1/vm-instances/fdd596303d5533e5ae5de2b49660e98a/isoParameter List
| Name | Type | Location | Description | Allowed Values | Starting Version |
|---|---|---|---|---|---|
| vmInstanceUuid | String | url | Virtual Machine UUID | 0.6 | |
| systemTags (optional) | List | body | System Tags | 0.6 | |
| userTags (optional) | List | body | User Tags | 0.6 | |
| isoUuid (optional) | String | body | 2.3.1 |
API Response
Return Example
{
"inventory": {
"uuid": "c11b752cf9ab3c1796932b6e2d31130b",
"name": "Test-VM",
"description": "web server VM",
"zoneUuid": "38bce95d22c13e9f9b4ebbee43fb19ff",
"clusterUuid": "9f22602c966b338b822653bfac3e01a0",
"imageUuid": "7f367e399b5e3d15b077288235834a44",
"hostUuid": "a99d812afd4136b3af5cc1ced6973ed4",
"lastHostUuid": "51391439dfa437daa7915c6fba892418",
"instanceOfferingUuid": "b2cd7abbfe28364399304140235314eb",
"rootVolumeUuid": "ed654518b598324f8b2c5f2b4942ac32",
"platform": "Linux",
"defaultL3NetworkUuid": "f03ba780bfe73e45ab06aff246101170",
"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": "5f41aff015d63ba5b58cb9596ccbfb24",
"vmInstanceUuid": "c11b752cf9ab3c1796932b6e2d31130b",
"usedIpUuid": "0b520f1c41f33ce9a62c70c0724e26b6",
"l3NetworkUuid": "f03ba780bfe73e45ab06aff246101170",
"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": "ed654518b598324f8b2c5f2b4942ac32",
"name": "Root-Volume-For-VM-c11b752cf9ab3c1796932b6e2d31130b",
"primaryStorageUuid": "db4c942c7a4c33cb9d2184c1dda9c431",
"vmInstanceUuid": "c11b752cf9ab3c1796932b6e2d31130b",
"diskOfferingUuid": "fbeca8e72bdc313c83767b3f40d1cd79",
"rootImageUuid": "7f367e399b5e3d15b077288235834a44",
"installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-ed654518b598324f8b2c5f2b4942ac32/ed654518b598324f8b2c5f2b4942ac32.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 | Resource description | 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 | Instance 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 | Distributed Port Group 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 Number | 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 | Distributed Port Group UUID | 0.6 |
| ipVersion | Integer | IP Protocol Number | 3.1.0 |
| ip | String | IP Address | 0.6 |
| netmask | String | Netmask | 0.6 |
| gateway | String | Gateway Address | 0.6 |
| usedFor | String | 0.6 | |
| ipInLong | long | 0.6 | |
| vmNicUuid | String | VM 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 | Resource description | 0.6 |
| primaryStorageUuid | String | Data Storage UUID | 0.6 |
| vmInstanceUuid | String | Virtual Machine UUID | 0.6 |
| diskOfferingUuid | String | 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 | Creation Time | 0.6 |
| lastOpDate | Timestamp | Last Operation Date | 0.6 |
| isShareable | Boolean | 0.6 | |
| volumeQos | String | 4.7.13 | |
| 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 | Resource description | 4.7.13 |
| createDate | Timestamp | Creation Time | 4.7.13 |
| lastOpDate | Timestamp | Last Operation Date | 4.7.13 |
SDK Examples
Java SDK
DetachIsoFromVmInstanceAction action = new DetachIsoFromVmInstanceAction();
action.vmInstanceUuid = "fdd596303d5533e5ae5de2b49660e98a";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DetachIsoFromVmInstanceAction.Result res = action.call();Python SDK
action = DetachIsoFromVmInstanceAction()
action.vmInstanceUuid = "fdd596303d5533e5ae5de2b49660e98a"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()