文档首页/ 密码安全中心 DEW/ API参考（联盟区域）/ API说明/ 管理加密密钥/ 创建数据密钥
更新时间：2026-03-19 GMT+08:00
查看PDF
分享

创建数据密钥

功能介绍

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

URI

  • URI格式

    POST /v1.0/{project_id}/kms/create-datakey

  • 参数说明
    表1 路径参数

    参数

    是否必选

    参数类型

    描述

    project_id

    是

    String

    项目ID。

请求消息

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

Content-Type

是

String

application/json
表3 请求参数

参数

是否必选

参数类型

描述

key_id

是

String

Key_id内容可使用密钥ID、别名（key_alias）或者URN。

  • 密钥ID：36字节，满足正则匹配“^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$”。示例：0d0466b0-e727-4d9c-b35d-f84bb474a37f
  • 别名：别名是为用户为密钥设置的简称，是密钥的一种标识。以“alias/”开头。示例：alias/4555。
  • URN：每个别名都会自动匹配一个URN，具有唯一性。示例：kms:eu-de-ring0:3ba44455500dd43127:alias:4555。
    说明：

    “创建密钥别名”时，生成的alias_urn，即为URN。

encryption_context

否

Object

一系列key-value键值对，用于记录资源上下文信息，用于保护数据的完整性，不应包含敏感信息，最大长度为8192。

当在加密时指定了该参数时，解密密文时，需要传入相同的参数，才能正确的解密。

例如：{"Key1":"Value1","Key2":"Value2"}

datakey_length

否

String

密钥bit位长度，取值为“512”。

sequence

否

String

请求消息序列号，36字节序列号。

例如：919c82d4-8046-4722-9094-35c3c6524cff

响应消息

表4 响应参数

参数

是否必选

参数类型

描述

key_id

是

String

密钥ID。

plain_text

是

String

DEK明文16进制，两位表示1byte。

cipher_text

是

String

DEK密文16进制，两位表示1byte。

示例

如下以创建密钥ID为“0d0466b0-e727-4d9c-b35d-f84bb474a37f”，密钥长度为“512”bit的数据密钥为例。

  • 请求样例 
    {
    "key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
    "datakey_length": "512"
}
  • 响应样例 
    {
    "key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
    "plain_text": "8151014275E426C72EE7D44267EF11590DCE0089E19863BA8CC832187B156A72A5A17F17B5EF0D525872C59ECEB72948AF85E18427F8BE0D46545C979306C08D",
    "cipher_text": "020098009EEAFCE122CAA5927D2E020086F9548BA1675FDB022E4ECC01B96F2189CF4B85E78357E73E1CEB518DAF7A4960E7C7DE8885ED3FB2F1471ABF400119CC1B20BD3C4A9B80AF590EFD0AEDABFDBB0E2B689DA7B6C9E7D3C5645FCD9274802586BE63779471F9156F2CDF07CD8412FFBE9230643034363662302D653732372D346439632D623335642D6638346262343734613337660000000045B05321483BD9F9561865EE7DFE9BE267A42EB104E98C16589CE46940B18E52"
}

    或

    {
    "error": {
        "error_code": "KMS.XXXX",
        "error_msg": "XXX"
    }
}

状态码

表5描述的是API返回的正常状态码。
表5 状态码

状态码

编码

状态说明

200

OK

请求已成功。

异常状态码，请参见状态码。

父主题： 管理加密密钥