API概览
数据加密服务提供的接口类型，以及接口对应的性能参数，您可以完整的使用数据加密服务的所有功能。
性能参数类型包括共享流控以及基础流控，其中：
- 共享流控：本类型分类接口共同使用流量。
- 基础流控：仅由该接口的流量使用。
未单独标识基础流控接口，均为共享流控，例如创建凭据版本接口。
类型 |
说明 |
|---|---|
管理加密密钥 |
加密密钥管理接口，包括密钥的创建，查询，修改，删除等接口。 |
凭据管理服务 |
凭据管理接口，包括凭据的创建，查询，修改，删除等接口。 |
管理SSH密钥对 |
SSH密钥对管理接口（最新版本），包括SSH密钥对的创建，查询，修改，删除等接口。 |
历史全局 |
SSH密钥对管理接口（V2.1和V2版本），包括SSH密钥对的创建，查询，修改，删除等接口。 |
管理加密密钥
类型 |
名称 |
说明 |
性能参数 |
|---|---|---|---|
查询全局版本信息 |
查询API版本信息列表。 |
- |
|
查指定API版本信息。 |
|||
生命周期管理 |
创建用户主密钥，用户主密钥可以为对称密钥或非对称密钥。 |
单用户20次/秒 全局100次/秒 |
|
启用密钥，密钥启用后才可以使用。 |
|||
禁用密钥，密钥禁用后不可以使用。 |
|||
计划删除一个指定密钥，可设置7天～1096天内删除密钥。密钥将被彻底删除后，使用该密钥加密的数据将无法解密。 |
|||
取消计划删除密钥，取消后，用户可以正常使用该密钥。 |
|||
修改用户主密钥别名。 |
|||
修改用户主密钥描述信息。 |
|||
数据密钥管理 |
生成8~8192bit范围内的随机数。 |
单用户800次/秒 全局1000次/秒 |
|
创建数据密钥，返回结果包含明文和密文。 |
|||
创建数据密钥，返回结果只包含密文。 |
|||
使用指定的用户主密钥加密数据密钥。 |
|||
使用指定的用户主密钥解密数据密钥。 |
|||
导入密钥管理 |
获取导入密钥的必要参数，包括密钥导入令牌和密钥加密公钥。 |
单用户20次/秒 全局100次/秒 |
|
导入指定密钥的密钥材料。 |
|||
删除指定密钥的密钥材料。 |
|||
授权管理 |
被授权用户可以对授权密钥进行操作。 |
单用户20次/秒 全局100次/秒 |
|
授权用户撤销被授权用户操作密钥的权限。 |
|||
被授权用户不再具有授权密钥的操作权。 |
|||
查询密钥的授权列表。 |
|||
查询用户可以退役的授权列表。 |
|||
小数据加解密 |
使用指定的用户主密钥加密数据。 |
单用户20次/秒 全局100次/秒 |
|
解密数据。 |
|||
签名验签 |
使用非对称密钥的私钥对消息或消息摘要进行数字签名。 |
单用户300次/秒 全局500次/秒 |
|
使用非对称密钥的公钥对消息或消息摘要进行签名验证。 |
|||
轮换管理 |
开启用户主密钥轮换，默认主密钥及外部导入密钥不支持轮换操作。 |
单用户20次/秒 全局100次/秒 |
|
关闭用户主密钥轮换。 |
|||
修改用户主密钥轮换周期。 |
|||
查询用户主密钥轮换状态。 |
|||
标签管理 |
通过标签过滤，查询指定用户主密钥的详细信息。 |
单用户20次/秒 全局100次/秒 |
|
查询指定密钥的标签信息。 |
|||
查询用户在指定项目下的所有标签集合。 |
|||
批量添加或删除密钥标签。 |
|||
添加密钥标签。 |
|||
删除密钥标签。 |
|||
查询接口 |
查询用户所有密钥列表。 |
单用户160次/秒 全局200次/秒 |
|
查询指定密钥的详细信息。 |
|||
获取用户已经创建的用户主密钥数量，不包含默认主密钥。 |
单用户80次/秒 全局200次/秒 |
||
查询用户可以创建的用户主密钥配额总数及当前使用量信息，不包含默认主密钥。 |
|||
专属密钥库管理 |
创建租户专属密钥库，专属密钥库使用DHSM实例作为密钥的存储。 |
单用户20次/秒 全局100次/秒 |
|
查询租户专属密钥库列表。 |
|||
获取租户专属密钥库。 |
|||
删除租户专属密钥库。 |
|||
启用租户专属密钥库。 |
|||
禁用租户专属密钥库。 |
凭据管理服务
类型 |
名称 |
说明 |
配额 |
|---|---|---|---|
生命周期管理 |
创建新的凭据，并将凭据值存入凭据的初始版本。 |
单用户300次/分钟 全局4800次/分钟 |
|
查询当前用户在本项目下创建的所有凭据。 |
单用户100次/秒 全局 200次/秒 |
||
查询指定凭据的信息。 |
单用户1200次/分钟 全局 4800次/分钟 |
||
更新指定凭据的元数据信息。 |
单用户300次/分钟 全局4800次/分钟 |
||
立即删除指定的凭据，且无法恢复。 |
|||
通过上传凭据备份文件，恢复凭据对象。 |
|||
下载指定凭据的备份文件。 |
|||
指定延迟删除时间，创建删除凭据的定时任务，可设置7~30天的的延迟删除时间。 |
|||
取消凭据的定时删除任务，凭据对象恢复可使用状态。 |
|||
立即执行轮转凭据。在指定的凭据中，创建一个新的凭据版本，用于加密存储后台随机产生的凭据值。同时将新创建的凭据版本标记为SYSCURRENT状态。 |
|||
凭据版本管理 |
在指定的凭据中，创建一个新的凭据版本，用于加密保管新的凭据值。默认情况下，新创建的凭据版本被标记为SYSCURRENT状态，而SYSCURRENT标记的前一个凭据版本被标记为SYSPREVIOUS状态。您可以通过指定VersionStage参数来覆盖默认行为。 |
基础流控： 单用户80次/秒 全局 200次/秒 应用80次/秒 IP 80次/秒 |
|
查询指定凭据下的版本列表信息。 |
单用户300次/分钟 全局4800次/分钟 |
||
当前支持更新指定凭据版本的有效期，只能更新ENABLED状态的凭据。在关联订阅的事件包含“版本过期”基础事件类型时，每次更新版本有效期后仅会触发一次事件通知。 |
|||
查询指定凭据版本的信息和版本中的明文凭据值，只能查询ENABLED状态的凭据。 通过/v1/{project_id}/secrets/{secret_name}/versions/latest （即将当前接口URL中的{version_id}赋值为latest）可访问凭据最新版本的凭据值。 |
基础流控： 单用户160次/秒 全局 200次/秒 应用160次/秒 IP 160次/秒 |
||
凭据版本状态管理 |
更新凭据的版本状态。 |
单用户300次/分钟 全局4800次/分钟 |
|
查询指定凭据版本状态标记的版本信息。 |
|||
删除指定的凭据版本状态。 |
|||
凭据标签管理 |
查询凭据实例。通过标签过滤，筛选用户凭据，返回凭据列表。 |
单用户300次/分钟 全局4800次/分钟 |
|
批量添加或删除凭据标签。 |
|||
查询凭据标签。 |
|||
添加凭据标签。 |
|||
删除凭据标签。 |
|||
查询用户在指定项目下的所有凭据标签集合。 |
|||
事件管理 |
创建事件，事件可配置在一个或多个凭据对象上。当事件为启用状态且包含的基础事件类型在凭据对象上触发时，云服务会将对应的事件通知发送至事件指定的通知主题上。 |
单用户300次/分钟 全局4800次/分钟 |
|
查询指定事件的信息。 |
|||
查询当前用户在本项目下创建的所有事件。 |
|||
更新指定事件的元数据信息。支持更新的元数据包含事件启用状态、基础类型列表、通知主题。 |
|||
立即删除指定的事件，且无法恢复。如事件存在凭据引用，则无法删除，请先解除关联。 |
|||
查询三个月内所有已触发的事件通知记录。 |
管理SSH密钥对
类型 |
名称 |
说明 |
配额 |
|---|---|---|---|
密钥对管理 |
创建和导入SSH密钥对。 |
单用户300次/分钟 全局4800次/分钟 |
|
清除SSH密钥对私钥。 |
|||
查询SSH密钥对列表。 |
基础流控： 单用户160次/秒 全局 200次/秒 应用160次/秒 IP 160次/秒 |
||
查询SSH密钥对详细信息。 |
|||
删除SSH密钥对。 |
单用户300次/分钟 全局4800次/分钟 |
||
更新SSH密钥对描述。 |
|||
导入私钥到指定密钥对。 |
|||
导出指定密钥对的私钥。 |
|||
密钥对任务管理 |
给指定的虚拟机绑定（替换或重置，替换需提供虚拟机已配置的SSH密钥对私钥；重置不需要提供虚拟机的SSH密钥对私钥）新的SSH密钥对。 |
单用户300次/分钟 全局4800次/分钟 |
|
给指定的虚拟机解除绑定SSH密钥对并恢复SSH密码登录。 |
|||
给指定的虚拟机批量绑定新的SSH密钥对。 |
基础流控： 单用户10次/分钟 全局 20次/分钟 应用10次/分钟 IP 10次/分钟 |
||
根据SSH密钥对接口返回的task_id，查询SSH密钥对当前任务的执行状态。 |
单用户300次/分钟 全局4800次/分钟 |
||
查询正在处理的任务信息。 |
|||
查询绑定、解绑等操作失败的任务信息。 |
|||
删除操作失败的任务信息。 |
|||
删除失败的任务。 |
历史全局
全局分类 |
说明 |
|---|---|
管理SSH密钥对(V2.1) |
查询SSH密钥对列表。 |
查询SSH密钥对详细信息。 |
|
创建SSH密钥对和导入SSH密钥对，同时可选择对私钥进行托管。 |
|
根据SSH密钥对的名称，删除指定SSH密钥对。 |
|
根据SSH密钥对的名称，修改指定SSH密钥对的描述信息。 |
|
管理SSH密钥对(V2.0) |
查询SSH密钥对信息列表。 |
根据SSH密钥对的名称查询指定SSH密钥对。 |
|
创建SSH密钥对，或把公钥导入华为云中，生成SSH密钥对。 创建SSH密钥对成功后，请把响应数据中的私钥内容保存到本地文件，单用户使用该私钥登录云服务器。为保证云服务器安全，私钥数据只能下载一次，请妥善保管。 |
|
根据SSH密钥对的名称，删除指定SSH密钥对。 |
|
在同一个租户下可能包含多个单用户账号，将同一租户下目标单用户账号下的密钥对复制到当前单用户账号下。 |
