使用对称密钥将明文加密为密文。
接口说明
注意事项
-
RAM 用户或 RAM 角色调用该 OpenAPI 需要被授予的权限策略详情，请参见访问控制。
-
本接口可以通过共享网关或专属网关调用。详细介绍，请参见阿里云 SDK。
共享网关：通过公网、VPC 域名访问 KMS，该方式需要打开公网开关。具体操作，请参见通过公网访问 KMS 实例中的密钥。
专属网关：通过 KMS 私网地址（
<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com）访问 KMS。
QPS 限制
通过共享网关调用：本接口的单用户 QPS 限制为 1000 次/秒。超过限制，API 调用将会被限流，这可能影响您的业务，请合理调用。
通过专属网关调用：本接口的单用户 QPS 限制以您 KMS 实例的计算性能规格为准。详细介绍，请参见性能数据。
详细说明
KMS 使用指定密钥的主版本对传入数据进行加密。
最多可加密 6KB 的数据，例如 RSA 密钥、数据库密码或其它敏感信息。
如果将加密数据从一个地域迁移到另一个地域，可以调用 Encrypt 接口在新地域中加密从另一个地域中转移过来的明文 DataKey。新地域中会生成一个加密后的 DataKey。您可以在新地域调用 Decrypt 将其解密。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| KeyId |
string |
是 |
密钥的 ID，也可以指定为密钥别名或密钥资源名称（ARN）。关于别名的详细介绍，请参见管理密钥别名。 说明
访问其他阿里云账号下的密钥时，必须输入密钥 ARN。密钥 ARN 的格式为 |
key-hzz630494463ejqjx**** |
| Plaintext |
string |
是 |
待加密明文（必须经过 Base64 编码）。 |
SGVsbG8gd29y**** |
| EncryptionContext |
object |
否 |
key/value 的 JSON 字符串。如果指定了该参数，则在调用 Decrypt 时需要提供同样的参数，详情请参见 EncryptionContext 说明。 |
{"Example":"Example"} |
| DryRun |
string |
否 |
是否开启 DryRun 模式。
DryRun 模式用于测试 API 调用，验证您是否具有相应资源的权限，以及请求参数是否配置正确。请根据返回消息查看验证结果。
|
false |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| KeyVersionId |
string |
用于加密明文的密钥版本标志符。是指定密钥的主版本。 |
86a9efd9-3d16-4894-bd4f-1fc43f3f**** |
| KeyId |
string |
密钥 ID。如果请求中的 KeyId 参数使用的是密钥别名、密钥 ARN，在响应中会返回密钥 ID。 |
key-hzz630494463ejqjx**** |
| CiphertextBlob |
string |
数据被指定密钥的主版本加密后的密文。 |
DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK**** |
| RequestId |
string |
本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。 |
475f1620-b9d3-4d35-b5c6-3fbdd941423d |
示例
正常返回示例
JSON格式
{
"KeyVersionId": "86a9efd9-3d16-4894-bd4f-1fc43f3f****",
"KeyId": "key-hzz630494463ejqjx****",
"CiphertextBlob": "DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK****",
"RequestId": "475f1620-b9d3-4d35-b5c6-3fbdd941423d"
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 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. | 指定的别名找不到 |
| 404 | InvalidAccessKeyId.NotFound | The Access Key ID provided does not exist in our records. |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。