IBM Cloud Docs
查看关键版本

查看关键版本

使用IBM® Key Protect for IBM Cloud® 查看与根密钥相关的版本。

旋转根密钥时,Key Protect会创建新版本的密钥。 作为安全管理员,你可以通过查看根密钥的密钥版本历史记录来审核其旋转历史。

密钥版本仅适用于根密钥。 要进一步了解按键旋转在Key Protect 中的工作原理,请查看 比较按键旋转选项

您有多少个关键版本?

查看已部署的每个密钥有多少个版本:

  1. 登录IBM Cloud控制台

  2. 转到菜单>资源清单查看资源列表。

  3. 从 IBM Cloud 资源列表中,选择您供应的 Key Protect 实例。

  4. 密钥面板上,单击 ⋯ 图标并选择密钥详细信息。 这将打开一个侧边面板,其中除其他事项外,还显示你所拥有的该密钥的版本数量。

  5. 如果想知道实例中有多少个密钥版本,必须对实例中的每个密钥重复此过程。 请注意,由于只有根密钥可以旋转,所有标准密钥都只有一个版本。

使用 API 查看密钥版本

要查看高级视图,可以通过调用以下端点的 * 来列出与根键相关联的版本。 键相关联的版本 GET

https://<region>.kms.cloud.ibm.com/api/v2/keys/<keyID_or_alias>/versions
  1. 检索您的身份验证凭据,以便在服务中使用密钥

  2. 读取要检查的根密钥的 ID。

    ID 值用于访问密钥的详细信息。 您可以 中找到密钥的 ID Key Protect实例,方法是 检索密钥列表、 或访问Key Protect实例。 仪表盘。

  3. Get a list of versions that are associated with the root key by running the following curl command. 您还可以添加一个查询参数 ?totalCount=true,如图所示,在响应元数据中返回 totalCount,用于分页。

    $ curl -X GET \
        "https://<region>.kms.cloud.ibm.com/api/v2/keys/<keyID_or_alias>/versions?totalCount=<show_total>&allKeyStates=<work_for_keys_in_any_state>" \
        -H "accept: application/vnd.ibm.kms.key.version+json" \
        -H "authorization: Bearer <IAM_token>" \
        -H "x-kms-key-ring: <key_ring_ID>" \
        -H "bluemix-instance: <instance_ID>"
    

    根据下表替换示例请求中的变量。

描述使用Key ProtectAPI 列出密钥版本所需的变量。API 列出密钥版本所需的变量。
变量 描述
区域 需要。 地区缩写,如 us-southeu-gb,表示您的Key Protect实例所在的地理区域。 有关更多信息,请参阅区域服务端点
keyID_or_alias 需要。 要检查的密钥的唯一标识符或别名。
IAM_token 需要。 您的 IBM Cloud 访问令牌。 在 curl 请求中包含 IAM 令牌的全部内容,包括承载器值。 更多信息,请参阅 检索访问令牌
instance_ID 需要。 指定给您的 Key Protect 服务实例的唯一标识。 更多信息,请参阅 检索实例 ID
键环 ID 可选。 钥匙所属钥匙圈的唯一标识符。 标头本身是可选的,但如果未指定,Key Protect将在与指定实例相关的每个钥匙圈中搜索该钥匙。 建议指定钥匙圈 ID,以优化请求。 注意:创建时没有 x-kms-key-ring 标头的密钥环 ID 为:默认。 更多信息,请参阅 分组按键
显示总计 可选。 如果设置为 true,将在响应元数据中返回 totalCount,以便对处于活动状态的所有键进行分页,除非 allKeyStates 也设置为 true。 返回的 totalCount 值表示与请求匹配的密钥版本总数,不考虑限制和偏移量。 默认设置为 false。
allKeyStates 可选。 如果未设置为 true,所有非活动键都将返回 HTTP 409。

成功 GET api/v2/keys/<keyID_or_alias>/versions 响应会返回与根密钥相关联的 与根密钥相关联的版本列表。 以下 JSON 对象显示返回值示例。

{
    "metadata": {
        "collectionType": "application/vnd.ibm.kms.key.version+json",
        "collectionTotal": 2
    },
    "resources": [
        {
            "id": "02fd6835-6001-4482-a892-13bd2085f75d",
            "creationDate": "2020-03-05T16:39:25Z"
        },
        {
            "id": "12e8c9c2-a162-472d-b7d6-8b9a86b815a6",
            "creationDate": "2020-03-02T16:28:38Z"
        }
    ]
}

The resources object lists each key version, along with its ID and creation date, in reverse chronological order.