文档首页/ 数据加密服务 DEW/ API参考（吉隆坡区域）/ API说明/ 创建不含明文数据密钥
更新时间：2022-08-23 GMT+08:00
查看PDF
分享

创建不含明文数据密钥

功能介绍

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

URI

  • URI格式

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

  • 参数说明
    表1 参数说明

    参数

    是否必选

    参数类型

    描述

    project_id

    是

    String

    项目ID。

请求消息

表2 请求参数

参数

是否必选

参数类型

描述

key_id

是

String

密钥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

encryption_context

否

Object

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

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

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

datakey_length

否

String

密钥bit位长度。

取值为8的倍数，取值范围为8~8192。

key_spec

否

String

指定生成的密钥bit位长度。

有效值：AES_256、AES_128。

  • AES_256：表示256比特的对称密钥。
  • AES_128：表示128比特的对称密钥。
说明：

datakey_length和key_spec二选一。

  • 若datakey_length和key_spec都为空，默认生成256bit的密钥。
  • 若datakey_length和key_spec都指定了值，仅datakey_length生效。

sequence

否

String

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

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

响应消息

表3 响应参数

参数

是否必选

参数类型

描述

key_id

是

String

密钥ID。

cipher_text

是

String

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

示例

如下以创建密钥ID为“0d0466b0-e727-4d9c-b35d-f84bb474a37f”的不含明文数据密钥为例。

  • 请求样例 
    {
    "key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
    "datakey_length": "512"
}
  • 响应样例 
    {
    "key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
    "cipher_text": "020098005CDC28E29EC3230AA42E8985FBABA095037D6474C64519C9B564AB28B15739C88E7E887500D1094973C2DC16353DB7ED3946C73339517AB1E983D521F9E9D700DC5D9C42F557EBF3F608E3CBBEE0BC68136EE7D2A49117E00332BAC4AE4ED805EB6068FA900C5A8019BFE2C2651BE3E130643034363662302D653732372D346439632D623335642D66383462623437346133376600000000F160727EBDB83400C21D80D713B49D3A2C37F24AE160E7BB3DAC025ADC0C45E3"
}

    或

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

状态码

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

状态码

编码

状态说明

200

OK

请求已成功。

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

父主题： API说明