使用 UI 创建密钥别名

通过完成以下步骤，使用 UI 创建密钥别名:

1. 登录 UI。

2. 去菜单>资源列表查看您的资源列表。

3. 从 IBM Cloud 资源列表，选择 Hyper Protect Crypto Services 的已供应实例。

4. 在侧边菜单中选择 KMS 密钥 选项卡，然后查找要为其创建密钥别名的密钥。

5. 单击 操作 图标 以打开密钥的选项列表，然后单击 编辑密钥别名。

6. 输入以逗号分隔的密钥别名。 您最多可以为一个密钥添加五个别名。

   每个别名必须是字母数字，区分大小写，并且不能包含除短划线 (-) 或下划线 (_) 以外的空格或特殊字符。别名不能是 V 4 UUID，也不能是 Hyper Protect Crypto Services 保留名称: allowed_ip，key，keys，metadata，policy，policies，registration，registrations，ring，rings，rotate，wrap，unwrap，rewrap，version 和 versions。别名大小可以是 2-90 个字符 (含)。

7. 单击保存。

使用 API 创建密钥别名

通过创建 POST 调用以下端点。

https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys/<key_ID>/aliases/<alias>

1. 检索认证凭证以使用服务中的密钥。

   要创建密钥别名，必须为您分配 管理者 或 写程序 服务访问角色。 了解 IAM 角色如何映射到 Hyper Protect Crypto Services 服务操作，请查看 服务访问角色。

2. 通过运行以下 curl 命令来创建密钥别名。

   $ curl -X POST \
       "https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys/<key_ID>/aliases/<key_alias>" \
       -H "authorization: Bearer <IAM_token>" \
       -H "bluemix-instance: <instance_ID>" \
       -H "content-type: application/vnd.ibm.kms.key+json" \
       -H "correlation-id: <correlation_ID>"
   

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

   表 1. 描述使用 Hyper Protect Crypto Services API 创建密钥别名所需的变量

   变量	描述
   region	必需。 地区缩写，例如 us-south，代表您的Hyper Protect Crypto Services实例驻留。 有关更多信息，请参阅区域服务端点。
   port	必需。 API 端点的端口号。
   key_ID	必需。 要与别名关联的密钥的标识。 要检索密钥标识，请参阅 list keys API。
   key_alias	必需。 密钥的人类可读的唯一名称，以便可轻松识别密钥。 每个别名必须是字母数字，区分大小写，并且不能包含除短划线 (-) 或下划线 (_) 以外的空格或特殊字符。 别名不能是 V 4 UUID ，也不能是 Hyper Protect Crypto Services 保留名称: allowed_ip， key， keys， metadata， policy， policies， registration， registrations， ring， rings， rotate， wrap， unwrap， rewrap， version和 versions。 别名大小可以是 2-90 个字符 (含)。 注: 不能在 Hyper Protect Crypto Services 实例中具有重复的别名。
   IAM_token	必需。 您的 IBM Cloud 访问令牌。 包括完整内容 IAM 令牌，包括 Bearer 值，在 curl 要求。 有关详细信息，请参阅For more information, see 检索访问令牌。
   instance_ID	必需。 指定给您的 Hyper Protect Crypto Services 服务实例的唯一标识。 有关详细信息，请参阅For more information, see 检索实例 ID。
   correlation_ID	用于跟踪和关联事务的唯一标识。

   为了保护您的个人数据的机密性，在创建密钥别名时请避免输入个人身份信息 (PII)，例如您的姓名或位置。 有关 PII 的更多示例，请参阅部分2.2的 NIST 特别出版物 800-122。

   一个成功的 POST api/v2/keys/<key_ID>/aliases/<key_alias> 响应返回您的密钥的别名以及其他元数据。 别名是分配给密钥的唯一名称，可用于检索有关关联密钥的更多信息。

   {
       "metadata": {
           "collectionType": "application/vnd.ibm.kms.key+json",
           "collectionTotal": 1
       },
       "resources": [
           {
               "keyId": "02fd6835-6001-4482-a892-13bd2085f75d",
               "alias": "test-alias",
               "creationDate": "2020-03-12T03:37:32Z",
               "createdBy": "..."
           }
       ]
   }
   

   有关响应参数的详细说明，请参阅Hyper Protect Crypto ServicesREST API 参考文档。

使用 UI 删除密钥别名

通过完成以下步骤，使用 UI 删除密钥别名:

1. 登录 UI。
2. 去菜单>资源列表查看您的资源列表。
3. 从 IBM Cloud 资源列表，选择 Hyper Protect Crypto Services 的已供应实例。
4. 在侧边菜单中选择 KMS 密钥 选项卡，然后查找要为其创建密钥别名的密钥。
5. 单击 操作 图标 以打开密钥的选项列表，然后单击 编辑密钥别名。
6. 删除要除去的密钥别名，然后单击 保存。

使用 API 删除密钥别名

通过对以下端点进行 DELETE 调用来删除密钥别名。

https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys/<key_ID>/aliases/<alias>

1. 检索认证凭证以使用服务中的密钥。

2. 通过运行以下 curl 命令来删除密钥别名。

   $ curl -X DELETE \
       "https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys/<key_ID>/aliases/<key_alias>" \
       -H "authorization: Bearer <IAM_token>" \
       -H "bluemix-instance: <instance_ID>" \
       -H "content-type: application/vnd.ibm.kms.key+json" \
       -H "correlation-id: <correlation_ID>"
   

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

   表 2. 描述使用 Hyper Protect Crypto Services API 删除密钥别名所需的变量

   变量	描述
   region	必需。 地区缩写，例如 us-south，代表您的Hyper Protect Crypto Services实例驻留。 有关更多信息，请参阅区域服务端点。
   port	必需。 API 端点的端口号。
   key_ID	必需。 密钥的唯一标识符。
   key_alias	必需。 标识密钥的唯一人类可读名称。
   IAM_token	必需。 您的 IBM Cloud 访问令牌。 包括完整内容 IAM 令牌，包括 Bearer 值，在 curl 要求。 有关详细信息，请参阅For more information, see 检索访问令牌。
   instance_ID	必需。 指定给您的 Hyper Protect Crypto Services 服务实例的唯一标识。 有关详细信息，请参阅For more information, see 检索实例 ID。
   correlation_ID	用于跟踪和关联事务的唯一标识。

   成功的 DELETE api/v2/keys/<key_ID>/aliases/<key_alias> 请求将返回 HTTP 204 No Content 响应，这指示已删除与密钥关联的别名。

   从服务中删除别名最多需要 10 分钟。