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

查询可恢复密钥列表 - ListRestorableKeys

功能介绍

查询当前项目下所有有快照的密钥列表，标注是否可恢复，支持分页

调用方法

请参见如何调用API。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    kms:cmk:listRestorableKeys

    List

    -

    -

    -

    -

URI

GET /v1.0/{project_id}/kms/backups/restorable-keys

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

字符长度32-32。

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释：

指定查询返回记录条数

约束限制：

limit的值需为正整数

取值范围：

1-100

默认取值：

不涉及

offset

否

Integer

参数解释：

分页偏移量，表示从第几条记录开始查询

约束限制：

offset的值需为非负整数

取值范围：

不涉及

默认取值：

0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

count

Integer

参数解释：

返回的可恢复密钥数量

取值范围：

不涉及

keys

Array of RestorableKeyInfo objects

参数解释：

可恢复密钥列表

取值范围：

不涉及
表5 RestorableKeyInfo

参数

参数类型

描述

key_id

String

参数解释：

密钥ID

取值范围：

不涉及

key_alias

String

参数解释：

密钥别名

取值范围：

不涉及

key_state

Integer

参数解释：

密钥状态

取值范围：

  • 2：启用中

  • 3：已禁用

  • 4：计划删除

  • 5：待激活

  • 6：已删除

restorable

Boolean

参数解释：

是否可恢复（密钥记录从数据库完全删除时为true）

取值范围：

  • true：可恢复

  • false：不可恢复

snapshot_id

String

参数解释：

最近一次备份快照ID

取值范围：

不涉及

latest_backup_time

String

参数解释：

最近一次备份时间

取值范围：

不涉及

请求示例

无

响应示例

状态码：200

{
  "count" : 2,
  "keys" : [ {
    "key_id" : "0d0466b0-e727-4d9f-bd9b-e0cda5bddd3d",
    "key_alias" : "my-key",
    "key_state" : 4,
    "restorable" : true,
    "snapshot_id" : "a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d",
    "latest_backup_time" : "2026-01-15T08:30:00Z"
  }, {
    "key_id" : "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "key_alias" : "my-key2",
    "key_state" : 4,
    "restorable" : false,
    "snapshot_id" : "b2c3d4e5-f6a7-8b9c-0d1e-2f3a4b5c6d7e",
    "latest_backup_time" : "2026-01-16T10:00:00Z"
  } ]
}

状态码

状态码

描述

200

请求成功

错误码

请参见错误码。

父主题： 备份与恢复