虚拟机相关接口

查询虚拟机设备地址归档

GET/zstack/v1/vmInstance/resource/metadata/archive
GET/zstack/v1/vmInstance/resource/metadata/archive/{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/resource/metadata/archive?q=uuid=2fb96aa3ba1e3cc394a3da88a7dbfcac
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/vmInstance/resource/metadata/archive/a69a76218ec8365c9b521199fe6ee76b

可查询字段

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

API返回

返回示例

{
  "inventories": [
    {
      "id": 1,
      "resourceUuid": "407c6a2680a73506b3b4df1674505a14",
      "deviceAddress": "{\"bus\":\"00\",\"domain\":\"0000\",\"slot\":\"0d\",\"function\":\"0\"}",
      "addressGroupUuid": "b415541c97ac340dbd88c3256a0f6829",
      "metadata": "Metadata",
      "metadataClass": "org.zstack.header.vm.devices.VmInstanceResourceMetadataArchiveInventory",
      "createDate": "Nov 14, 2017 2:20:57 PM",
      "lastOpDate": "Nov 14, 2017 2:20:57 PM"
    }
  ]
}
名字类型描述起始版本
successboolean请求是否成功4.10.16
inventoriesList详情参考inventories4.10.16
errorErrorCode详情参考error4.10.16

inventories

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

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

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

Python SDK

action = QueryVmInstanceResourceMetadataArchiveAction()
action.conditions = ["uuid=a7025094e4d63dd29180ae7b08450029"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()