虚拟机相关接口

虚拟机转换为虚拟机模板

POST/zstack/v1/vm-instances/{vmInstanceUuid}/convert-to-templatedVmInstance

Headers

Authorization: OAuth the-session-uuid

Body

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

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{}}' http://localhost:8080/zstack/v1/vm-instances/ad7a18919c8331f3a3b2fa482414afee/convert-to-templatedVmInstance

参数列表

名字类型位置描述可选值起始版本
vmInstanceUuidStringurl虚拟机UUID 4.2.6
systemTags (可选)Listbody系统标签 4.2.6
userTags (可选)Listbody用户标签 4.2.6

API返回

返回示例

{
  "inventory": {
    "uuid": "dc492d9719aa36c28c890817a0f739df",
    "name": "templatedVmInstance",
    "zoneUuid": "fcb916b1966c3502903e9781df537c56",
    "createDate": "Nov 14, 2017 10:20:57 PM",
    "lastOpDate": "Nov 14, 2017 10:20:57 PM"
  }
}
名字类型描述起始版本
successboolean 4.2.6
errorErrorCode错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error4.2.6
inventoryTemplatedVmInstanceInventory详情参考inventory4.2.6

error

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

inventory

名字类型描述起始版本
uuidString资源的UUID,唯一标示该资源4.2.6
nameString资源名称4.2.6
zoneUuidString数据中心UUID4.2.6
createDateTimestamp创建时间4.2.6
lastOpDateTimestamp最后一次修改时间4.2.6

SDK示例

Java SDK

ConvertVmInstanceToTemplatedVmInstanceAction action = new ConvertVmInstanceToTemplatedVmInstanceAction();
action.vmInstanceUuid = "ad7a18919c8331f3a3b2fa482414afee";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ConvertVmInstanceToTemplatedVmInstanceAction.Result res = action.call();

Python SDK

ConvertVmInstanceToTemplatedVmInstanceAction action = ConvertVmInstanceToTemplatedVmInstanceAction()
action.vmInstanceUuid = "ad7a18919c8331f3a3b2fa482414afee"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ConvertVmInstanceToTemplatedVmInstanceAction.Result res = action.call()