调用Encrypt接口使用对称主密钥(Symmetric CMK)将明文加密为密文。
注意事项
- 非KMS实例中的密钥:进行密码运算时,仅支持通过阿里云SDK调用OpenAPI。
- KMS实例中的密钥:进行密码运算时,支持如下两种方式。
- 方式一(推荐):通过KMS实例SDK调用KMS实例API。详细介绍,请参见KMS实例SDK、KMS实例API。
- 方式二:通过阿里云SDK调用OpenAPI,但认证方式仅支持可信实体为阿里云服务的RAM角色。详细信息,请参见创建可信实体为阿里云服务的RAM角色。
QPS限制
本接口的单用户QPS限制为750次/秒。超过限制,API调用将会被限流,这可能影响您的业务,请合理调用。
详细说明
- KMS使用指定CMK的主版本对传入数据进行加密。
- 最多可加密6KB的数据,例如RSA密钥、数据库密码或其它敏感信息。
- 如果将加密数据从一个地域迁移到另一个地域,可以调用Encrypt接口在新地域中加密从另一个地域中转移过来的明文DataKey。新地域中会生成一个加密后的DataKey。您可以在新地域调用Decrypt将其解密。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | Encrypt | 系统规定参数。取值:Encrypt。 |
KeyId | String | 是 | 1234abcd-12ab-34cd-56ef-12345678**** | 主密钥(CMK)的全局唯一标识符。该参数也可以被指定为CMK绑定的别名,详情请参见别名使用说明。 |
Plaintext | String | 是 | SGVsbG8gd29y**** | 待加密明文(必须经过Base64编码)。 |
EncryptionContext | Map | 否 | {"Example":"Example"} | key/value的JSON字符串。如果指定了该参数,则在调用Decrypt时需要提供同样的参数,详情请参见EncryptionContext说明。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
KeyVersionId | String | 86a9efd9-3d16-4894-bd4f-1fc43f3f**** | 用于加密明文的密钥版本标志符。是指定CMK的主版本。 |
KeyId | String | 1234abcd-12ab-34cd-56ef-12345678**** | CMK的全局唯一标识符。如果请求中的KeyId参数使用的是CMK的别名,在响应中会返回别名对应的CMK标志符。 |
CiphertextBlob | String | DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK**** | 数据被指定CMK的主版本加密后的密文。 |
RequestId | String | 475f1620-b9d3-4d35-b5c6-3fbdd941423d | 请求ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=Encrypt
&KeyId=1234abcd-12ab-34cd-56ef-12345678****
&Plaintext=SGVsbG8gd29y****
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<EncryptResponse>
<KeyVersionId>86a9efd9-3d16-4894-bd4f-1fc43f3f****</KeyVersionId>
<KeyId>1234abcd-12ab-34cd-56ef-12345678****</KeyId>
<CiphertextBlob>DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK****</CiphertextBlob>
<RequestId>475f1620-b9d3-4d35-b5c6-3fbdd941423d</RequestId>
</EncryptResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"KeyVersionId" : "86a9efd9-3d16-4894-bd4f-1fc43f3f****",
"KeyId" : "1234abcd-12ab-34cd-56ef-12345678****",
"CiphertextBlob" : "DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK****",
"RequestId" : "475f1620-b9d3-4d35-b5c6-3fbdd941423d"
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
400 | InvalidParameter | The specified parameter is invalid. | 参数错误 |
404 | Forbidden.KeyNotFound | The specified Key is not found. | 指定的密钥不存在。 |
404 | Forbidden.AliasNotFound | The specified Alias is not found. | 指定的别名找不到 |
访问错误中心查看更多错误码。
反馈
- 本页导读 (1)
文档反馈