CreateVmCdRom

API Request

URLs
POST zstack/v1/vm-instances/cdroms
Headers
Authorization: OAuth the-session-uuid
Body
{
  "params": {
    "name": "cd-1",
    "vmInstanceUuid": "157321b6fb043d8a923aca66e6388086",
    "description": "this is a cd-rom"
  },
  "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 POST -d '{"params":{"name":"cd-1","vmInstanceUuid":"157321b6fb043d8a923aca66e6388086","description":"this is a cd-rom"}}' http://localhost:8080/zstack/v1/vm-instances/cdroms
Request Parameters
Name Type Location Description Optional Value Starting Version
name String body (contained in the params structure) The resource name. 3.3.0
vmInstanceUuid String body (contained in the params structure) The VM instance UUID. 3.3.0
isoUuid String body (contained in the params structure) Optional. The ISO image UUID. 3.3.0
description String body (contained in the params structure) Optional. The detailed description of the resource. 3.3.0
resourceUuid String body (contained in the params structure) Optional. The resource UUID. 3.3.0
systemTags List body Optional. The system tags. 3.3.0
userTags List body Optional. The user tags. 3.3.0

API Response

Sample Response
{
  "inventory": {
    "vmInstanceUuid": "47286977f0c530168fdbb1dfbfc167e8",
    "deviceId": 0.0,
    "isoUuid": "1712d13459ec3637be1020936e76e5a3",
    "name": "cd-1",
    "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. 3.3.0
inventory VmCdRomInventory See inventory. 3.3.0
#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. 3.3.0
description String The brief description of the error. 3.3.0
details String The details about the error. 3.3.0
elaboration String The reserved field. Default value: null. 3.3.0
opaque LinkedHashMap The reserved field. Default value: null. 3.3.0
cause ErrorCode The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. 3.3.0
#inventory
Name Type Description Starting Version
uuid String The resource UUID. 3.3.0
vmInstanceUuid String The VM instance UUID. 3.3.0
deviceId Integer The CD-ROM device ID. 3.3.0
isoUuid String The ISO image UUID. 3.3.0
isoInstallPath String The path to install the ISO image. 3.3.0
name String The resource name. 3.3.0
description String The detailed description of the resource. 3.3.0
createDate Timestamp The creation date. 3.3.0
lastOpDate Timestamp The last operation date. 3.3.0

SDK Sample

Java SDK
CreateVmCdRomAction action = new CreateVmCdRomAction();
action.name = "cd-1";
action.vmInstanceUuid = "157321b6fb043d8a923aca66e6388086";
action.description = "this is a cd-rom";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateVmCdRomAction.Result res = action.call();
Python SDK
CreateVmCdRomAction action = CreateVmCdRomAction()
action.name = "cd-1"
action.vmInstanceUuid = "157321b6fb043d8a923aca66e6388086"
action.description = "this is a cd-rom"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CreateVmCdRomAction.Result res = action.call()