文档首页/ 密码安全中心 DEW/ API参考/ API/ 管理加密密钥/ 备份与恢复/ 恢复密钥 - BatchRestoreKey
更新时间：2026-11-06 GMT+08:00
查看PDF
分享

恢复密钥 - BatchRestoreKey

功能介绍

从OBS备份快照恢复密钥到密钥库。同步执行，直接返回恢复结果。

只有密钥记录从数据库完全删除才允许恢复；若目标密钥记录仍存在，将拒绝整个恢复请求。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    kms:cmk:restoreKey

    Write

    -

    -

    -

    -

URI

POST /v1.0/{project_id}/kms/backups/batch-restore

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，用于唯一标识用户项目。可参考获取项目ID获取，以IAM服务接口返回值为准

约束限制：

不涉及

取值范围：

字符长度32-32。

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值），以IAM服务查询用户Token接口为准

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

key_ids

是

Array of strings

参数解释：

待恢复的密钥ID列表

约束限制：

  • 不能为空

  • 列表最多100个元素

  • 列表中每个元素为36字节UUID

  • 满足正则匹配"^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$"

取值范围：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

restored_keys

Array of RestoredKeyInfo objects

参数解释：

已恢复的密钥列表

取值范围：

不涉及
表5 RestoredKeyInfo

参数

参数类型

描述

key_id

String

参数解释：

已恢复的密钥ID

取值范围：

不涉及

charge_id

String

参数解释：

计费资源ID

取值范围：

不涉及

请求示例

恢复指定密钥

{
  "key_ids" : [ "0d0466b0-e727-4d9f-bd9b-e0cda5bddd3d" ]
}

响应示例

状态码：200

{
  "restored_keys" : [ {
    "key_id" : "0d0466b0-e727-4d9f-bd9b-e0cda5bddd3d",
    "charge_id" : "a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d"
  } ]
}

状态码

状态码

描述

200

请求成功

错误码

请参见错误码。

父主题： 备份与恢复