将明文加密为密文。_密钥管理服务(Key Management Service)-阿里云帮助中心

调用Encrypt接口将明文加密为密文。

使用说明

Encrypt和AdvanceEncrypt都用于将明文数据加密为密文，区别为：

Encrypt：加密时使用密钥的初始版本，加密后可以使用Decrypt或AdvanceDecrypt解密。
AdvanceEncrypt：加密时使用密钥的主版本，加密后需要使用AdvanceDecrypt解密。但目前仅KMS软件密钥管理实例中的对称密钥支持使用该接口。

重要

如果您使用KMS软件密钥管理实例中的对称密钥，且密钥开启了自动轮转，加密时请使用AdvanceEncrypt，以避免轮转功能不生效。关于密钥轮转的相关内容，请参见密钥轮转。

关于密钥规格、加密模式以及密钥版本的详细信息，请参见密钥管理类型和密钥规格。

注意事项

所有请求参数使用Protocol Buffers编码后（即Request Body），内容长度不能超过3 MB，超过3 MB后服务端会拒绝处理并返回HTTP 413状态码。建议单次使用对称密钥加解密的数据不超过6 KB，单次使用非对称密钥加解密的数据不超过1 KB，超过后请使用信封加密方案。详细信息，请参见使用KMS密钥进行信封加密。

说明

单次加解密的数据量越大，网络传输失败可能性越大，网络传输所需时间越长，KMS实例对数据进行加解密所需时间也越长。

请求参数

名称	类型	是否必选	示例值	描述
KeyId	string	是	key-hzz62f1cb66fa42qo****	密钥的全局唯一标识符。该参数也可以被指定为密钥别名。
Plaintext	bytes	是	二进制数据	待加密的明文数据。
Algorithm	string	否	AES_GCM	加密算法。如果未指定本参数，KMS会使用加密算法默认值。更多信息，请参见密钥管理类型和密钥规格。
Iv	bytes	否	二进制数据	对数据加密时使用的初始向量。仅当加密算法（Algorithm参数）为AES_GCM、AES_CBC或SM4_GCM时本参数有效。加密算法（Algorithm）为AES_CBC时：Iv长度为16字节。加密算法（Algorithm）为AES_GCM或SM4_GCM时：Iv长度为12字节。如果未指定本参数，KMS将随机生成。重要推荐您不指定本参数，由KMS随机生成。
Aad	binary	否	二进制数据	对数据加密时使用的GCM加密模式认证数据。当密钥是对称密钥、加密算法（Algorithm）是AES_GCM或SM4_GCM时，您可以按需要使用本参数。重要如果指定了本参数，调用Decrypt解密时需要指定相同的参数。
PaddingMode	string	否	PKCS7_PADDING	填充模式。仅当加密算法为AES_CBC或AES_ECB时，需要提供本参数。取值： PKCS7_PADDING（默认值）：即PKCS#7填充。数据明文或密文内容的长度可以不是相应块密码算法块大小（K字节）的整数倍。当输入数据明文或密文内容长度为L字节时，系统将填充K -（L mod K）字节的内容，填充的每个字节为均为K -（L mod K）。 NO_PADDING：不对数据明文填充。数据明文内容的长度必须为相应块密码算法块大小的整数倍。

响应数据

名称	类型	示例值	描述
Iv	bytes	二进制数据	加密数据时使用的初始向量。仅当加密算法（Algorithm参数）为AES_GCM、AES_CBC或SM4_GCM时，本参数返回有效值，其他场景返回空值。
CiphertextBlob	bytes	二进制数据	数据被指定密钥加密后的密文。说明当采用ECIES算法时，返回的密文格式遵循SEC 1: Elliptic Curve Cryptography, Version 2.0标准。
KeyId	string	key-hzz62f1cb66fa42qo****	密钥的全局唯一标识符。如果请求中的KeyId参数使用的是密钥别名，在响应中会返回别名对应的密钥的全局唯一标识符。
Algorithm	string	AES_GCM	加密算法。
PaddingMode	string	PKCS7_PADDING	填充模式。仅当加密算法（Algorithm参数）为AES_CBC或AES_ECB时，本参数返回有效值，其他场景返回空值。
RequestId	string	475f1620-b9d3-4d35-b5c6-3fbdd941423d	本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。

错误码

访问公共错误码查看更多错误码。