加密

最近更新时间: 2026-04-09 18:11:29

1. 接口描述

接口请求域名： kms.api3.fincloud.tencent.cn。

本接口用于加密最多为4KB任意数据，可用于加密数据库密码，RSA Key，或其它较小的敏感信息。对于应用的数据加密，使用GenerateDataKey生成的DataKey进行本地数据的加解密操作

默认接口请求频率限制：300次/秒。

接口更新时间：2020-01-15 20:19:59。

接口只验签名不鉴权。

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：Encrypt
Version	是	否	String	公共参数，本接口取值：2019-01-18
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
KeyId	是	否	String	调用CreateKey生成的CMK全局唯一标识符示例值：
Plaintext	是	否	String	被加密的明文数据，该字段必须使用base64编码，原文最大长度支持4K 示例值：
EncryptionContext	否	否	String	key/value对的json字符串，如果指定了该参数，则在调用Decrypt API时需要提供同样的参数，最大支持1024个字符示例值：

参数名称	类型	描述
CiphertextBlob	String	加密后经过base64编码的密文示例值：
KeyId	String	加密使用的CMK的全局唯一标识示例值：
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameter	参数错误。
ResourceUnavailable.CmkDisabled	CMK已被禁用。
ResourceUnavailable.CmkNotFound	CMK不存在。
InvalidParameterValue.InvalidKeyId	KeyId不合法。
InvalidParameterValue.InvalidPlaintext	Plaintext不合法。
InternalError	内部错误。
UnauthorizedOperation	未授权操作。