GenerateDataKeyWithoutPlaintext_密钥管理服务_API文档-阿里云OpenAPI开发者门户

接口说明

本接口可以通过共享网关或专属网关调用。详细介绍，请参见阿里云 SDK。

共享网关：通过公网、VPC 域名访问 KMS，该方式需要打开公网开关。具体操作，请参见通过公网访问 KMS 实例中的密钥。
专属网关：通过 KMS 私网地址（<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com）访问 KMS。

此 API 随机生成一个数据密钥，并通过您指定的对称主密钥（Symmetric CMK）加密后，返回数据密钥的密文。此 API 和 GenerateDataKey 提供完全相同的功能，唯一的区别是此 API 不会返回数据密钥的明文。

您在请求中指定的 CMK，仅用于数据密钥的加密，不会用于数据密钥的生成。KMS 不会记录或存储随机生成的数据密钥。

说明

此 API 适用于不需要立即使用数据密钥完成数据加密的系统。系统需要加密时，通过调用 Decrypt 接口解开数据密钥的密文。

此 API 也适用于具有不同信任等级的分布式系统。例如：您的系统将数据按照既定划分策略存储到不同的分区中。其中的一个模块会预先创建不同的数据分区，对每一个分区分别产生不同的数据密钥。这一模块完成控制平面的初始化之后，并不参与数据的生产和消费，它是密钥分发者。而数据平面的模块，在产生和消费数据的时候，首先获取分区的数据密钥密文，在解开之后使用数据密钥的明文对数据执行加密或者解密操作，随后清除内存中的数据密钥明文。在这样的系统中，密钥分发者不需要获取到数据密钥的明文，只需要使用相关 CMK 的 GenerateDataKeyWithoutPlaintext 的权限；而数据的生产和消费者，不需要产生新的数据密钥，只需要使用相关 CMK 的 Decrypt 的权限。

当前云产品API请求速率暂未透出。

当前云产品暂无权限信息透出。

字段名称	字段详情
KeyIdstring	主密钥（CMK）的全局唯一标识符。该参数也可以被指定为 CMK 绑定的别名，详情请参见别名使用说明。示例值:599fa825-17de-417e-9554-bb032cc6****参考取值来源: ListKeys CreateKey
KeySpecstring	指定生成的数据密钥的长度，取值：展开详情示例值:AES_256枚举值:AES_256 AES_128参考取值来源: DescribeKey CreateKey
NumberOfBytesinteger<int32>	指定生成的数据密钥的长度。展开详情示例值:256取值 <= 1024
EncryptionContextobject	key/value 对的 JSON 字符串，如果指定了该参数，则在调用 Decrypt 时需要提供同样的参数，详情请参见 EncryptionContext 说明。示例值:{"Example":"Example"}
DryRunstring	是否开启 DryRun 模式。展开详情示例值:false

字段名称	字段详情
KeyVersionIdstring	用于加密明文的密钥版本标志符。是指定 CMK 的主版本。示例值:2ab1a983-7072-4bbc-a582-584b5bd8****
KeyIdstring	CMK 的全局唯一标识符。展开详情示例值:599fa825-17de-417e-9554-bb032cc6****
CiphertextBlobstring	数据密钥被指定 CMK 的主版本加密后的密文。示例值:ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS****
RequestIdstring	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。示例值:7021b6ec-4be7-4d3c-8a68-1e85d4d515a0

没有我想要的错误码, 点击反馈

HTTP 状态码	错误码	错误信息	操作

400	InvalidParameter	The specified parameter is not valid.	诊断
404	InvalidAccessKeyId.NotFound	The Access Key ID provided does not exist in our records.	诊断
404	Forbidden.KeyNotFound	The specified Key is not found.	诊断

	变更时间	变更内容概要	操作
	2024-08-13	新增请求参数DryRun
	2022-09-22	新增错误码400 新增错误码404