密钥提供程序相关接口

对指定密钥重新加密

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

Headers

Authorization: OAuth the-session-uuid

Body

{
  "rekeyKeyProviderRefs": {
    "refIds": [
      1,
      2
    ],
    "rekeyAll": false
  },
  "systemTags": [],
  "userTags": []
}

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"rekeyKeyProviderRefs":{"refIds":[1,2],"rekeyAll":false}}' \
http://localhost:8080/zstack/v1/key-providers/ff0340e5866e385b9a86e592dd7e1900/rekey

参数列表

名字类型位置描述可选值起始版本
refIds (可选)Listbody(包含在rekeyKeyProviderRefs结构中)需要重加密的密钥引用ID列表 5.0.0
resourceUuids (可选)Listbody(包含在rekeyKeyProviderRefs结构中)关联资源UUID列表，与resourceType配对使用 5.0.0
resourceType (可选)Stringbody(包含在rekeyKeyProviderRefs结构中)关联资源类型，与resourceUuids配对使用 5.0.0
providerUuidStringurl密钥提供程序UUID 5.0.0
rekeyAll (可选)booleanbody(包含在rekeyKeyProviderRefs结构中)是否执行全量重加密；为true时不能再指定refIds或resourceType/resourceUuids 5.0.0
systemTags (可选)Listbody系统标签 5.0.0
userTags (可选)Listbody用户标签 5.0.0

API返回

返回示例

{
  "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"
        }
      ]
    }
  ]
}
名字类型描述起始版本
successboolean 5.0.0
totalCountint本次涉及的源密钥提供者数量（按 resource ref 关联的 provider 去重）5.0.0
successCountint未出现失败 ref 的 provider 数量（含仅有 skip 的 provider）5.0.0
skippedCountint存在被跳过 ref 的 provider 数量5.0.0
failedCountint存在失败 ref 的 provider 数量5.0.0
providerResultsList按源密钥提供者聚合的结果；每个元素内含该 provider 下的 skippedResources、failedResources 及各类 ref 计数5.0.0
errorErrorCode详情参考error5.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

RekeyKeyProviderRefsAction action = new RekeyKeyProviderRefsAction();
action.refIds = asList(1,2);
action.providerUuid = "ff0340e5866e385b9a86e592dd7e1900";
action.rekeyAll = false;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
RekeyKeyProviderRefsAction.Result res = action.call();

Python SDK

action = RekeyKeyProviderRefsAction()
action.refIds = [1, 2]
action.providerUuid = "ff0340e5866e385b9a86e592dd7e1900"
action.rekeyAll = false
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

GET查询密钥提供程序

上一页

POST创建KMS密钥提供程序

下一页