修改云主机主板类型(SetVmMachineType)

API请求

URLs

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

Headers

Authorization: OAuth the-session-uuid

Body

{
  "setVmMachineType": {
    "machineType": "q35"
  },
  "systemTags": [],
  "userTags": []
}

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

Curl示例

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

参数列表

名字	类型	位置	描述	起始版本
uuid	String	url	云主机 UUID	5.5.38
machineType	String	body（包含在setVmMachineType结构中）	目标主板类型，仅支持 q35	5.5.38
systemTags (可选)	List	body	系统标签	5.5.38
userTags (可选)	List	body	用户标签	5.5.38

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

SetVmMachineTypeAction action = new SetVmMachineTypeAction();
action.uuid = "8b45bba4578f3e6eacc6f0a67f8603d6";
action.machineType = "q35";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
SetVmMachineTypeAction.Result res = action.call();

Python SDK

action = SetVmMachineTypeAction()
action.uuid = "8b45bba4578f3e6eacc6f0a67f8603d6"
action.machineType = "q35"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

上一篇发送文件到云主机(UploadFileToVm)下一篇云盘相关接口