查询虚拟机设备地址归档(QueryVmInstanceResourceMetadataArchive)

API请求

URLs

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"
    }
  ]
}

名字	类型	描述	起始版本
success	boolean	请求是否成功	4.10.16
inventories	List	详情参考inventories	4.10.16
error	ErrorCode	详情参考error	4.10.16

#inventories

名字	类型	描述	起始版本
id	long		4.10.16
resourceUuid	String	资源 UUID	4.10.16
vmInstanceUuid	String	虚拟机 UUID	4.10.16
deviceAddress	String	设备地址	4.10.16
addressGroupUuid	String		4.10.16
metadata	String		4.10.16
metadataClass	String		4.10.16
createDate	Timestamp	创建时间	4.10.16
lastOpDate	Timestamp	最后一次修改时间	4.10.16

#error

名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	0.6
description	String	错误的概要描述	0.6
details	String	错误的详细信息	0.6
elaboration	String	保留字段，默认为null	0.6
opaque	LinkedHashMap	保留字段，默认为null	0.6
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	0.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()

上一篇设置虚拟机DNS(SetVmDns)下一篇查询虚拟机设备地址组(QueryVmInstanceResourceMetadataGroup)