虚拟机相关接口

获取资源虚拟化软件信息

GET/zstack/v1/vm-instances/virtualizer-info

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/vm-instances/virtualizer-info? uuids=b5432fcc423434e7a5f5876f1fe1e910&uuids=67e54311bbef3b43b9c523b349b08ca9&uuids=d64aeea721f7331aa15e7fb95eee7390

参数列表

名字类型位置描述可选值起始版本
uuidsListquery资源的 uuid,可以为虚拟机或主机的 uuid 4.6.21
systemTags (可选)Listquery系统标签 4.6.21
userTags (可选)Listquery用户标签 4.6.21

API返回

返回示例

{
  "inventories": [
    {
      "uuid": "3ce46fb7eb2e369c88d5fd671d1c1694",
      "resourceType": "HostVO",
      "infoList": [
        {
          "hypervisor": "qemu-kvm",
          "currentVersion": "4.2.0-632.g6a6222b.el7",
          "expectVersion": "4.2.0-632.g6a6222b.el7",
          "matchState": "Matched"
        }
      ]
    },
    {
      "uuid": "5c10fab3f649380e9dce16bb22ffd572",
      "resourceType": "VmInstanceVO",
      "infoList": [
        {
          "hypervisor": "qemu-kvm",
          "currentVersion": "4.2.0-632.g6a6222b.el7",
          "expectVersion": "4.2.0-632.g6a6222b.el7",
          "matchState": "Matched"
        }
      ]
    },
    {
      "uuid": "78a8b78906233d57bce710e89b24ebc0",
      "resourceType": "VmInstanceVO",
      "infoList": [
        {
          "hypervisor": "qemu-kvm",
          "currentVersion": "4.2.0-632.g6a6222b.el7",
          "expectVersion": "4.2.0-632.g6a6222b.el7",
          "matchState": "Matched"
        }
      ]
    }
  ]
}
名字类型描述起始版本
successboolean操作是否成功4.6.21
errorErrorCode错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error4.6.21
inventoriesList详情参考inventories4.6.21

error

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

inventories

名字类型描述起始版本
uuidString资源的UUID,唯一标示该资源4.6.21
resourceTypeString资源类型4.6.21
errorList出现的查询错误,可能为 null4.6.21
infoListList详情参考infoList4.6.21

infoList

名字类型描述起始版本
hypervisorString虚拟化软件,一般qemu-kvm4.6.21
currentVersionString虚拟机当前使用的虚拟化软件版本 / 主机当前安装的虚拟化软件版本4.6.21
expectVersionString期望的虚拟化软件版本。如果待查询的是 VM,则期望的虚拟化软件版本来自主机;如果待查询的是主机,则期望的虚拟化软件版本来自管理节点4.6.21
matchStateString当前虚拟化软件版本和期望是否匹配。如果当前版本或期望有一方没有查到,则返回Unknown4.6.21

SDK示例

Java SDK

GetVirtualizerInfoAction action = new GetVirtualizerInfoAction();
action.uuids = asList("b5432fcc423434e7a5f5876f1fe1e910","67e54311bbef3b43b9c523b349b08ca9","d64aeea721f7331aa15e7fb95eee7390");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetVirtualizerInfoAction.Result res = action.call();

Python SDK

GetVirtualizerInfoAction action = GetVirtualizerInfoAction()
action.uuids = [b5432fcc423434e7a5f5876f1fe1e910, 67e54311bbef3b43b9c523b349b08ca9, d64aeea721f7331aa15e7fb95eee7390]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetVirtualizerInfoAction.Result res = action.call()