虚拟机相关接口

设置虚拟机显存

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

Headers

Authorization: OAuth the-session-uuid

Body

{
  "setVmQxlMemory": {
    "ram": 65536,
    "vram": 32768,
    "vgamem": 16384
  },
  "systemTags": [],
  "userTags": []
}

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"setVmQxlMemory":{"ram":65536,"vram":32768,"vgamem":16384}}' http://localhost:8080/zstack/v1/vm-instances/cc590b2129c437a487311b0f9a8a0dbc/actions

参数列表

名字类型位置描述可选值起始版本
uuidStringurl虚拟机UUID 3.7.0
ram (可选)Integerbody(包含在setVmQxlMemory结构中)默认值为65536 3.7.0
vram (可选)Integerbody(包含在setVmQxlMemory结构中)默认值为32768 3.7.0
vgamem (可选)Integerbody(包含在setVmQxlMemory结构中)默认值为16384 3.7.0
systemTags (可选)Listbody  3.7.0
userTags (可选)Listbody  3.7.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

SetVmQxlMemoryAction action = new SetVmQxlMemoryAction();
action.uuid = "cc590b2129c437a487311b0f9a8a0dbc";
action.ram = 65536;
action.vram = 32768;
action.vgamem = 16384;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
SetVmQxlMemoryAction.Result res = action.call();

Python SDK

SetVmQxlMemoryAction action = SetVmQxlMemoryAction()
action.uuid = "cc590b2129c437a487311b0f9a8a0dbc"
action.ram = 65536
action.vram = 32768
action.vgamem = 16384
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
SetVmQxlMemoryAction.Result res = action.call()