Query TPM

GET/zstack/v1/tpms

GET zstack/v1/tpms/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl Example

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/tpms?q=uuid=ff00de2d3ab43127b1abdac68f1e7f00

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/tpms/c7ff0c86fd7c38908f619a9dfb610e68

Queryable Fields

Run the CLI tool, enter QueryTpm, and press Tab to view all queryable fields and resource names that support cross-table queries.

API Response

Response Example

{
  "inventories": [
    {
      "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"
    }
  ]
}

Name	Type	Description	Since
success	boolean	Whether the query operation succeeded	5.0.0
inventories	List	For details, see inventories	5.0.0
error	ErrorCode	For details, see error	5.0.0

inventories

Name	Type	Description	Since
uuid	String	TPM UUID	5.0.0
name	String	TPM resource name	5.0.0
vmInstanceUuid	String	VM UUID	5.0.0
createDate	Timestamp	Creation time	5.0.0
lastOpDate	Timestamp	Last modification time	5.0.0
hostRefs	List	For details, see hostRefs	5.0.0

fileRefs

Name	Type	Description	Since
uuid	String	Related file UUID	5.0.0
vmInstanceUuid	String	VM UUID	5.0.0
hostUuid	String	Host UUID	5.0.0
type	String	File type, classified by usage. Possible values are NvRam or TpmState	5.0.0
path	String	Path of the related file or directory on the host	5.0.0
createDate	Timestamp	Creation time	5.0.0
lastOpDate	Timestamp	Last modification time	5.0.0

error

Name	Type	Description	Since
code	String	Error code, a globally unique identifier of the error, for example, SYS.1000 or HOST.1001	0.6
description	String	Brief description of the error	0.6
details	String	Detailed information about the error	0.6
elaboration	String	Reserved field. The default value is null	0.6
opaque	LinkedHashMap	Reserved field. The default value is null	0.6
cause	ErrorCode	Root error, which is the source error that caused the current error. If there is no source error, this field is null	0.6

SDK Example

Java SDK

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

Python SDK

action = QueryTpmAction()
action.conditions = ["uuid=ff00de2d3ab43127b1abdac68f1e7f00"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()