跳转到主要内容
计算管理/虚拟机相关接口/密钥提供程序相关接口
PUTKey Provider APIs起始版本 5.0.0同步需要认证

对指定密钥重新加密

对指定密钥重新加密

调试可用性

在线调试

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

路径参数

请求参数

路径参数

  • providerUuidString必填

    密钥提供程序UUID

请求体字段

  • rekeykeyproviderrefsObject必填

    rekeykeyproviderrefs 请求体结构

    • refIdsList

      需要重加密的密钥引用ID列表

    • resourceUuidsList

      关联资源UUID列表,与resourceType配对使用

    • resourceTypeString

      关联资源类型,与resourceUuids配对使用

    • rekeyAllboolean

      是否执行全量重加密;为true时不能再指定refIds或resourceType/resourceUuids

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • successboolean必填

    操作是否成功。

  • totalCountint必填

    本次涉及的源密钥提供者数量(按 resource ref 关联的 provider 去重)

  • successCountint必填

    未出现失败 ref 的 provider 数量(含仅有 skip 的 provider)

  • skippedCountint必填

    存在被跳过 ref 的 provider 数量

  • failedCountint必填

    存在失败 ref 的 provider 数量

  • providerResultsList必填

    按源密钥提供者聚合的结果;每个元素内含该 provider 下的 skippedResources、failedResources 及各类 ref 计数

  • errorErrorCode必填

    详情参考error

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段,默认为null

    • opaqueLinkedHashMap必填

      保留字段,默认为null

    • causeErrorCode必填

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

请求地址

PUT/zstack/v1/key-providers/{providerUuid}/rekey

/zstack/v1/key-providers/{providerUuid}/rekey

操作 ID

RekeyKeyProviderRefs

永久链接

请求示例

curl -X PUT 'http://{host}/zstack/v1/key-providers/{providerUuid}/rekey' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"rekeykeyproviderrefs":{"refIds":["<refIds>"],"resourceUuids":["<resourceUuids>"],"resourceType":"<resourceType>","rekeyAll":true},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "totalCount": 3, "successCount": 1, "skippedCount": 1, "failedCount": 1, "providerResults": [ { "providerUuid": "provider-uuid-1", "providerName": "provider-1", "totalRefCount": 3, "successRefCount": 1, "skippedRefCount": 1, "failedRefCount": 1, "skippedResources": [ { "keyRefId": 11, "resourceType": "TpmVO", "resourceUuid": "ff00de2d3ab43127b1abdac68f1e7f00", "reason": "encrypted resource key ref[id:11, resourceType:TpmVO, resourceUuid:ff00de2d3ab43127b1abdac68f1e7f00] has empty secret ref" } ], "failedResources": [ { "keyRefId": 12, "resourceType": "TpmVO", "resourceUuid": "ff00de2d3ab43127b1abdac68f1e7f00", "reason": "key-tool rekey failed: failed to decrypt wrapper DEK with KEK" } ] } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史