跳转到主要内容
API Explorer|API Explorer
计算管理/虚拟机相关接口/vTPM相关接口
GETvTPM-related APIs起始版本 5.0.0同步需要认证

获取TPM详情数据

获取TPM详情数据

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

查询参数

请求参数

查询参数

  • tpmUuidString

    暂无描述。

  • vmInstanceUuidString

    虚拟机 UUID

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • successboolean必填

    获取是否成功

  • inventoryTpmCapabilityView必填

    详情参考inventory

    • uuidString必填

      资源的UUID，唯一标识该资源。

    • nameString必填

      TPM 资源名称

    • vmInstanceUuidString必填

      虚拟机 UUID

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • edkVersionString必填

      EDK 套件版本

    • swtpmVersionString必填

      SWTPM 版本

    • resetTpmAfterVmCloneConfigboolean必填

      是否在虚拟机克隆后重置 TPM 状态的配置

    • fileRefsList必填

      详情参考fileRefs

      • uuidString必填

        相关文件 UUID

      • vmInstanceUuidString必填

        虚拟机 UUID

      • hostUuidString必填

        主机 UUID

      • typeString必填

        文件类型, 按用途分类, 可能是 NvRam 或者 TpmState

      • pathString必填

        主机侧相关文件或目录的路径

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

  • errorErrorCode必填

    详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

请求地址

GET/zstack/v1/tpms/capability

/zstack/v1/tpms/capability

操作 ID

GetTpmCapability

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/tpms/capability?tpmUuid=<tpmUuid>&vmInstanceUuid=<vmInstanceUuid>&systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "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 } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史