获取TPM详情数据

GET/zstack/v1/tpms/capability

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/tpms/capability?vmInstanceUuid=ff01ec80fd11327cba7519b66119d900

参数列表

名字	类型	位置	描述	起始版本
tpmUuid (可选)	String	query	TPM UUID	5.0.0
vmInstanceUuid (可选)	String	query	虚拟机 UUID	5.0.0
systemTags (可选)	List	query	系统标签	5.0.0
userTags (可选)	List	query	用户标签	5.0.0

API返回

返回示例

{
  "inventory": {
    "uuid": "ff00de2d3ab43127b1abdac68f1e7f00",
    "name": "TPM-for-VM-ff01ec80fd11327cba7519b66119d900",
    "vmInstanceUuid": "ff01ec80fd11327cba7519b66119d900",
    "createDate": "Nov 14, 2017 2:20:57 PM",
    "lastOpDate": "Nov 14, 2017 2:20:57 PM",
    "fileRefs": [
      {
        "uuid": "ff0ee7dfcb8a3aa5b3534a1667c90400",
        "vmInstanceUuid": "ff01ec80fd11327cba7519b66119d900",
        "hostUuid": "ff0192fa70113da886101145c084bd00",
        "type": "TpmState",
        "path": "/var/lib/libvirt/swtpm/ff0192fa70113da886101145c084bd00/",
        "lastSyncReason": "on libvirt shutdown event",
        "createDate": "Nov 14, 2017 2:20:57 PM",
        "lastOpDate": "Nov 14, 2017 2:20:57 PM"
      }
    ],
    "edkVersion": "edk2-ovmf-20220126gitbb1bba3d77-3.el8.noarch",
    "swtpmVersion": "0.8.2",
    "resetTpmAfterVmCloneConfig": true
  }
}

名字	类型	描述	起始版本
success	boolean	获取是否成功	5.0.0
inventory	TpmCapabilityView	详情参考inventory	5.0.0
error	ErrorCode	详情参考error	5.0.0

inventory

名字	类型	描述	起始版本
uuid	String	TPM UUID	5.0.0
name	String	TPM 资源名称	5.0.0
vmInstanceUuid	String	虚拟机 UUID	5.0.0
createDate	Timestamp	创建时间	5.0.0
lastOpDate	Timestamp	最后一次修改时间	5.0.0
edkVersion	String	EDK 套件版本	5.0.0
swtpmVersion	String	SWTPM 版本	5.0.0
resetTpmAfterVmCloneConfig	boolean	是否在虚拟机克隆后重置 TPM 状态的配置	5.0.0
fileRefs	List	详情参考fileRefs	5.0.0

fileRefs

名字	类型	描述	起始版本
uuid	String	相关文件 UUID	5.0.0
vmInstanceUuid	String	虚拟机 UUID	5.0.0
hostUuid	String	主机 UUID	5.0.0
type	String	文件类型, 按用途分类, 可能是 NvRam 或者 TpmState	5.0.0
path	String	主机侧相关文件或目录的路径	5.0.0
createDate	Timestamp	创建时间	5.0.0
lastOpDate	Timestamp	最后一次修改时间	5.0.0

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

GetTpmCapabilityAction action = new GetTpmCapabilityAction();
action.vmInstanceUuid = "ff01ec80fd11327cba7519b66119d900";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetTpmCapabilityAction.Result res = action.call();

Python SDK

action = GetTpmCapabilityAction()
action.vmInstanceUuid = "ff01ec80fd11327cba7519b66119d900"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()