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

虚拟机添加TPM

虚拟机添加TPM

调试可用性

在线调试

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

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • keyProviderUuidString

      密钥提供程序 UUID

    • vmInstanceUuidString必填

      虚拟机 UUID

    • resourceUuidString

      资源 UUID

    • tagUuidsList

      标签 UUID 列表

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • successboolean必填

    添加是否成功

  • inventoryTpmInventory必填

    详情参考inventory

    • uuidString必填

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

    • nameString必填

      TPM 资源名称

    • vmInstanceUuidString必填

      虚拟机 UUID

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • hostRefsList必填

      详情参考hostRefs

      • 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

请求地址

POST/zstack/v1/tpms

/zstack/v1/tpms

操作 ID

AddTpm

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/tpms' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"keyProviderUuid":"<keyProviderUuid>","vmInstanceUuid":"<vmInstanceUuid>","resourceUuid":"<resourceUuid>","tagUuids":["<tagUuids>"]},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

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

变更历史

此 API 暂无变更历史记录。

查看全部变更历史