虚拟机相关接口

设置虚拟机启动模式

PUT/zstack/v1/vm-instances/{uuid}/actions

Headers

Authorization: OAuth the-session-uuid

Body

{
  "setVmBootMode": {
    "bootMode": "Legacy"
  },
  "systemTags": [],
  "userTags": []
}

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"setVmBootMode":{"bootMode":"Legacy"}}' http://localhost:8080/zstack/v1/vm-instances/aeba3a383f02352bb855f15f73e3840d/actions

参数列表

名字类型位置描述可选值起始版本
uuidStringurl资源的UUID,唯一标示该资源 4.2.0
bootModeStringbody(包含在setVmBootMode结构中)  4.2.0
systemTags (可选)Listbody  4.2.0
userTags (可选)Listbody  4.2.0

API返回

该API成功时返回一个空的JSON结构**{}**,出错时返回的JSON结构包含一个error字段,例如:

{
  "error": {
    "code": "SYS.1001",
    "description": "A message or a operation timeout",
    "details": "Create VM on KVM timeout after 300s"
  }
}

SDK示例

Java SDK

SetVmBootModeAction action = new SetVmBootModeAction();
action.uuid = "aeba3a383f02352bb855f15f73e3840d";
action.bootMode = "Legacy";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
SetVmBootModeAction.Result res = action.call();

Python SDK

SetVmBootModeAction action = SetVmBootModeAction()
action.uuid = "aeba3a383f02352bb855f15f73e3840d"
action.bootMode = "Legacy"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
SetVmBootModeAction.Result res = action.call()