虚拟机相关接口

查询虚拟机设备地址组

GET/zstack/v1/vmInstance/device/address/group
GET/zstack/v1/vmInstance/device/address/group/{uuid}

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/vmInstance/device/address/group?q=uuid=15faf301daf53b75a5292b501110397e
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/vmInstance/device/address/group/ce8802c036843741bfd429cddb5c0f26

可查询字段

运行CLI命令行工具,输入QueryVmInstanceDeviceAddressGroup并按Tab键查看所有可查询字段以及可跨表查询的资源名。

API返回

返回示例

{
  "inventories": [
    {
      "uuid": "77cc648bcbda321f9b5982627618b57f",
      "resourceUuid": "b28bd07303de3b8bb88ecc45778ebc10",
      "createDate": "Nov 14, 2017 2:20:57 PM",
      "lastOpDate": "Nov 14, 2017 2:20:57 PM",
      "addressList": [
        {
          "id": 1,
          "resourceUuid": "664783c1fb2432b6944602836377d61f",
          "vmInstanceUuid": "7f29c11b15b3348a95bc368b4ab60efb",
          "deviceAddress": "{\"bus\":\"00\",\"domain\":\"0000\",\"slot\":\"0d\",\"function\":\"0\"}",
          "addressGroupUuid": "77cc648bcbda321f9b5982627618b57f",
          "metadata": "{\"uuid\":\"726104d38c423fecac45c39a258b1338\",\"name\":\"Root-Volume-For-VM-70f0a99c825d3bed98c95932e5cd6d0b\",\"primaryStorageUuid\":\"0a2c36ffd5ff39d6a4ffd3d6a2a60ea8\",\"vmInstanceUuid\":\"70f0a99c825d3bed98c95932e5cd6d0b\",\"diskOfferingUuid\":\"a0c51ff80bba366d8350d63d02d56346\",\"rootImageUuid\":\"8473469c3e833afbb02db9ed227787bd\",\"installPath\":\"/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-726104d38c423fecac45c39a258b1338/726104d38c423fecac45c39a258b1338.qcow2\",\"type\":\"Root\",\"format\":\"qcow2\",\"size\":107374182400,\"actualSize\":21474836480,\"deviceId\":0,\"state\":\"Enabled\",\"status\":\"Ready\",\"createDate\":\"Nov 14, 2017 2:20:57 PM\",\"lastOpDate\":\"Nov 14, 2017 2:20:57 PM\"}",
          "metadataClass": "org.zstack.header.vm.devices.VmInstanceDeviceAddressGroupInventory",
          "createDate": "Nov 14, 2017 2:20:57 PM",
          "lastOpDate": "Nov 14, 2017 2:20:57 PM"
        }
      ]
    }
  ]
}
名字类型描述起始版本
successboolean 4.4.24
inventoriesList详情参考inventories4.4.24
errorErrorCode错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error4.4.24

inventories

名字类型描述起始版本
uuidString资源的UUID,唯一标示该资源4.4.24
resourceUuidString资源UUID4.4.24
vmInstanceUuidString虚拟机UUID4.4.24
createDateTimestamp创建时间4.4.24
lastOpDateTimestamp最后一次修改时间4.4.24
addressListList详情参考addressList4.4.24

addressList

名字类型描述起始版本
idlong 4.4.24
resourceUuidString资源UUID4.4.24
vmInstanceUuidString虚拟机UUID4.4.24
deviceAddressString 4.4.24
addressGroupUuidString 4.4.24
metadataString 4.4.24
metadataClassString 4.4.24
createDateTimestamp创建时间4.4.24
lastOpDateTimestamp最后一次修改时间4.4.24

error

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

SDK示例

Java SDK

QueryVmInstanceDeviceAddressGroupAction action = new QueryVmInstanceDeviceAddressGroupAction();
action.conditions = asList("uuid=c6ac07294e923ed09d8ac26fb0bcd2de");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryVmInstanceDeviceAddressGroupAction.Result res = action.call();

Python SDK

QueryVmInstanceDeviceAddressGroupAction action = QueryVmInstanceDeviceAddressGroupAction()
action.conditions = ["uuid=089878d0a83330a8a0a07c878266fc52"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryVmInstanceDeviceAddressGroupAction.Result res = action.call()