更新TPM

PUT/zstack/v1/tpms

Headers

Authorization: OAuth the-session-uuid

Body

{
  "updateTpm": {
    "vmInstanceUuid": "ff01ec80fd11327cba7519b66119d900",
    "keyProviderUuid": "ff03c7091617357eb4022d11c6860e00"
  },
  "systemTags": [],
  "userTags": []
}

上述示例中systemTagsuserTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateTpm":{"vmInstanceUuid":"ff01ec80fd11327cba7519b66119d900","keyProviderUuid":"ff03c7091617357eb4022d11c6860e00"}}' \
http://localhost:8080/zstack/v1/tpms

参数列表

名字类型位置描述可选值起始版本
vmInstanceUuid (可选)Stringbody(包含在updateTpm结构中)虚拟机 UUID 5.0.0
tpmUuid (可选)Stringbody(包含在updateTpm结构中)TPM UUID 5.0.0
keyProviderUuid (可选)Stringbody(包含在updateTpm结构中)密钥提供程序 UUID 5.0.0
systemTags (可选)Listbody系统标签 5.0.0
userTags (可选)Listbody用户标签 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"
  }
}
名字类型描述起始版本
successboolean更新是否成功5.0.0
inventoryTpmInventory详情参考inventory5.0.0
errorErrorCode详情参考error5.0.0

inventory

名字类型描述起始版本
uuidStringTPM UUID5.0.0
nameStringTPM 资源名称5.0.0
vmInstanceUuidString虚拟机 UUID5.0.0
createDateTimestamp创建时间5.0.0
lastOpDateTimestamp最后一次修改时间5.0.0
hostRefsList详情参考hostRefs5.0.0

fileRefs

名字类型描述起始版本
uuidString相关文件 UUID5.0.0
vmInstanceUuidString虚拟机 UUID5.0.0
hostUuidString主机 UUID5.0.0
typeString文件类型, 按用途分类, 可能是 NvRam 或者 TpmState5.0.0
pathString主机侧相关文件或目录的路径5.0.0
createDateTimestamp创建时间5.0.0
lastOpDateTimestamp最后一次修改时间5.0.0

error

名字类型描述起始版本
codeString错误码号,错误的全局唯一标识,例如SYS.1000, HOST.10010.6
descriptionString错误的概要描述0.6
detailsString错误的详细信息0.6
elaborationString保留字段,默认为null0.6
opaqueLinkedHashMap保留字段,默认为null0.6
causeErrorCode根错误,引发当前错误的源错误,若无原错误,该字段为null0.6

SDK示例

Java SDK

UpdateTpmAction action = new UpdateTpmAction();
action.vmInstanceUuid = "ff01ec80fd11327cba7519b66119d900";
action.keyProviderUuid = "ff03c7091617357eb4022d11c6860e00";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateTpmAction.Result res = action.call();

Python SDK

action = UpdateTpmAction()
action.vmInstanceUuid = "ff01ec80fd11327cba7519b66119d900"
action.keyProviderUuid = "ff03c7091617357eb4022d11c6860e00"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()