文档首页 > > API参考> API概览

API概览

分享
更新时间:2020/09/23 GMT+08:00

数据加密服务提供的接口,您可以完整的使用数据加密服务的所有功能。

类型

说明

管理加密密钥

加密密钥管理接口,包括密钥的创建,查询,修改,删除等接口。

管理SSH密钥对

SSH密钥对管理接口(最新版本),包括SSH密钥对的创建,查询,修改,删除等接口。

历史API

SSH密钥对管理接口(V2.1和V2版本),包括SSH密钥对的创建,查询,修改,删除等接口。

管理加密密钥

API类别

API

说明

查询API版本信息

查询版本信息列表

--

查询指定版本信息

--

生命周期管理

创建密钥

创建一个用户主密钥。

启用密钥

启用密钥,密钥启用后才可以使用。

禁用密钥

禁用密钥,密钥禁用后不可以使用。

计划删除密钥

计划删除一个指定密钥,可设置7天~1096天内删除密钥。密钥将被彻底删除后,使用该密钥加密的数据将无法解密。

取消计划删除密钥

取消计划删除密钥,取消后,用户可以正常使用该密钥。

修改密钥别名

查询用户所有密钥列表。

修改密钥描述

查询指定密钥的详细信息。

数据密钥管理

创建随机数

生成8~8192bit范围内的随机数,且须为8的倍数。

创建数据密钥

创建数据密钥,返回结果包含明文和密文。

创建不含明文数据密钥

创建数据密钥,返回结果只包含密文。

加密数据密钥

使用指定的用户主密钥加密数据密钥。

解密数据密钥

使用指定的用户主密钥解密数据密钥。

导入密钥管理

获取密钥导入参数

获取导入密钥的必要参数,包括密钥导入令牌和密钥加密公钥。

导入密钥材料

导入指定密钥的密钥材料。

删除密钥材料

删除指定密钥的密钥材料。

授权管理

创建授权

被授权用户可以对授权密钥进行操作。

撤销授权

授权用户撤销被授权用户操作密钥的权限。

退役授权

被授权用户不再具有授权密钥的操作权。

查询授权列表

查询密钥的授权列表。

查询可退役授权列表

查询用户可以退役的授权列表。

小数据加解密

加密数据

使用指定的用户主密钥加密数据。

解密数据

解密数据。

轮换管理

开启密钥轮换

开启用户主密钥轮换,默认主密钥及外部导入密钥不支持轮换操作。

修改密钥轮换周期

修改用户主密钥轮换周期。

关闭密钥轮换

关闭用户主密钥轮换。

查询密钥轮换状态

查询用户主密钥轮换状态。

标签管理

查询密钥实例

通过标签过滤,查询指定用户主密钥的详细信息。

查询密钥标签

查询指定密钥的标签信息。

查询项目标签

查询用户在指定项目下的所有标签集合。

批量添加删除密钥标签

批量添加或删除密钥标签。

添加密钥标签

添加密钥标签。

删除密钥标签

删除密钥标签。

查询接口

查询密钥列表

查询用户所有密钥列表。

查询密钥信息

查询指定密钥的详细信息。

查询实例数

获取用户已经创建的用户主密钥数量,不包含默认主密钥。

查询配额

查询用户可以创建的用户主密钥配额总数及当前使用量信息,不包含默认主密钥。

管理SSH密钥对

API类别

API

说明

密钥对管理

查询SSH密钥对列表

查询SSH密钥对信息列表。

创建和导入SSH密钥对

创建SSH密钥对,或把公钥导入华为云中,生成SSH密钥对。

创建SSH密钥对成功后,请把响应数据中的私钥内容保存到本地文件,用户使用该私钥登录云服务器。为保证云服务器安全,私钥数据只能下载一次,请妥善保管。

查询SSH密钥对详细信息

根据SSH密钥对的名称查询指定SSH密钥对。

删除SSH密钥对

根据SSH密钥对的名称,删除指定SSH密钥对。

更新SSH密钥对描述

更新SSH密钥对描述信息。

密钥对任务管理

绑定SSH密钥对

给指定的虚拟机绑定(替换或重置,替换需提供虚拟机已配置的SSH密钥对私钥;重置不需要提供虚拟机的SSH密钥对私钥)新的SSH密钥对。

解绑SSH密钥对

给指定的虚拟机解除绑定SSH密钥对并恢复SSH密码登录。

查询任务信息

根据SSH密钥对接口返回的task_id,查询SSH密钥对当前任务的执行状态。

查询失败的任务信息

查询绑定、解绑等操作失败的任务信息。

删除所有失败的任务

删除操作失败的任务信息。

删除失败的任务

删除失败的任务。

查询正在处理的任务信息

查询正在处理的任务信息。

历史API

API分类

API

说明

管理SSH密钥对(V2.1)

查询SSH密钥对列表(V2.1)

查询SSH密钥对列表。

查询SSH密钥对详情(V2.1)

查询SSH密钥对详细信息。

创建及导入SSH密钥对(V2.1)

创建SSH密钥对和导入SSH密钥对,同时可选择对私钥进行托管。

删除SSH密钥对(V2.1)

根据SSH密钥对的名称,删除指定SSH密钥对。

修改密钥对描述信息(V2.1)

根据SSH密钥对的名称,修改指定SSH密钥对的描述信息。

管理SSH密钥对(V2.0)

查询SSH密钥对列表(V2)

查询SSH密钥对信息列表。

查询SSH密钥对详情(V2)

根据SSH密钥对的名称查询指定SSH密钥对。

创建及导入SSH密钥对(V2)

创建SSH密钥对,或把公钥导入华为云中,生成SSH密钥对。

创建SSH密钥对成功后,请把响应数据中的私钥内容保存到本地文件,用户使用该私钥登录云服务器。为保证云服务器安全,私钥数据只能下载一次,请妥善保管。

删除SSH密钥对(V2)

根据SSH密钥对的名称,删除指定SSH密钥对。

复制SSH密钥对(废弃)

在同一个租户下可能包含多个用户帐号,将同一租户下目标用户帐号下的密钥对复制到当前用户帐号下。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问