文档首页/ 密码安全中心 DEW/ API参考/ API/ 管理加密密钥/ 密钥空间/ 转移密钥 - TransferKey
更新时间：2026-11-06 GMT+08:00
查看PDF
分享

转移密钥 - TransferKey

功能介绍

用于将密钥从一个密钥空间转移到另一个密钥空间

  • ASSIGN：将密钥分配给目标密钥空间，仅支持对称密钥，且密钥必须未属于任何密钥空间。

调用方法

请参见如何调用API。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    kms:cmk:transferKey

    Write

    KeyId *

    -

    -

    -

URI

POST /v1.0/{project_id}/kms/key-spaces/transfer-key

表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_id

是

String

参数解释：

待转移的密钥ID

约束限制：

满足正则表达式^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

取值范围：

不涉及

默认取值：

不涉及

target_keyspace_id

是

String

参数解释：

目标密钥空间ID

约束限制：

满足正则表达式^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

取值范围：

不涉及

默认取值：

不涉及

transfer_mode

否

String

参数解释：

转移模式

约束限制：

ASSIGN模式仅支持对称密钥，且密钥必须未属于任何密钥空间，目标密钥空间类型需与密钥所属keystore类型匹配；

取值范围：

  • ASSIGN：将密钥分配给目标密钥空间

默认取值：

ASSIGN

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

key_id

String

参数解释：

转移后密钥的ID

取值范围：

不涉及

keyspace_id

String

参数解释：

密钥所属的目标密钥空间ID

取值范围：

不涉及

请求示例

无

响应示例

无

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

父主题： 密钥空间

相关文档