虚拟机相关接口

为虚拟机创建CDROM

POST/zstack/v1/vm-instances/cdroms

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "name": "cd-1",
    "vmInstanceUuid": "c613ed3c46d036cdb5f7af15a15788dc",
    "isoUuid": "157321b6fb043d8a923aca66e6388086",
    "description": "this is a cd-rom"
  },
  "systemTags": [],
  "userTags": []
}

上述示例中systemTagsuserTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"name":"cd-1","vmInstanceUuid":"c613ed3c46d036cdb5f7af15a15788dc","isoUuid":"157321b6fb043d8a923aca66e6388086","description":"this is a cd-rom"}}' http://localhost:8080/zstack/v1/vm-instances/cdroms

参数列表

名字类型位置描述可选值起始版本
nameStringbody(包含在params结构中)资源名称 3.3.0
vmInstanceUuidStringbody(包含在params结构中)虚拟机UUID 3.3.0
isoUuid (可选)Stringbody(包含在params结构中)ISO镜像UUID 3.3.0
description (可选)Stringbody(包含在params结构中)资源的详细描述 3.3.0
resourceUuid (可选)Stringbody(包含在params结构中)资源UUID 3.3.0
tagUuids (可选)Listbody(包含在params结构中)标签UUID列表 3.4.0
systemTags (可选)Listbody系统标签 3.3.0
userTags (可选)Listbody用户标签 3.3.0

API返回

返回示例

{
  "inventory": {
    "vmInstanceUuid": "47286977f0c530168fdbb1dfbfc167e8",
    "deviceId": 0,
    "isoUuid": "1712d13459ec3637be1020936e76e5a3",
    "name": "cd-1",
    "createDate": "Nov 14, 2017 10:20:57 PM",
    "lastOpDate": "Nov 14, 2017 10:20:57 PM"
  }
}
名字类型描述起始版本
successboolean 0.6
errorErrorCode错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error3.3.0
inventoryVmCdRomInventory详情参考inventory3.3.0

error

名字类型描述起始版本
codeString错误码号,错误的全局唯一标识,例如SYS.1000, HOST.10013.3.0
descriptionString错误的概要描述3.3.0
detailsString错误的详细信息3.3.0
elaborationString保留字段,默认为null3.3.0
opaqueLinkedHashMap保留字段,默认为null3.3.0
causeErrorCode根错误,引发当前错误的源错误,若无原错误,该字段为null3.3.0

inventory

名字类型描述起始版本
uuidString资源的UUID,唯一标示该资源3.3.0
vmInstanceUuidString虚拟机UUID3.3.0
deviceIdInteger光驱顺序号3.3.0
isoUuidStringISO镜像UUID3.3.0
isoInstallPathStringISO镜像挂载路径3.3.0
nameString资源名称3.3.0
descriptionString资源的详细描述3.3.0
createDateTimestamp创建时间3.3.0
lastOpDateTimestamp最后一次修改时间3.3.0

SDK示例

Java SDK

CreateVmCdRomAction action = new CreateVmCdRomAction();
action.name = "cd-1";
action.vmInstanceUuid = "c613ed3c46d036cdb5f7af15a15788dc";
action.isoUuid = "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 = "c613ed3c46d036cdb5f7af15a15788dc"
action.isoUuid = "157321b6fb043d8a923aca66e6388086"
action.description = "this is a cd-rom"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CreateVmCdRomAction.Result res = action.call()