ReEncrypt_密钥管理服务_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

注意事项

本接口仅支持通过共享网关调用,不支持通过专属网关调用。详细介绍,请参见阿里云 SDK

通过共享网关调用即通过公网、VPC 域名访问 KMS,该方式需要打开公网开关。具体操作,请参见通过公网访问 KMS 实例中的密钥

QPS 限制

  • 通过共享网关调用:本接口的单用户 QPS 限制为 750 次/秒。超过限制,API 调用将会被限流,这可能影响您的业务,请合理调用。
  • 通过专属网关调用:本接口的单用户 QPS 限制以您 KMS 实例的计算性能规格为准。详细介绍,请参见性能数据

详细说明

ReEncrypt 使用场景如下:

  • 主密钥(CMK)进行轮转后,使用轮转后最新的密钥版本对数据进行重新加密。自动轮转密钥详情,请参见自动轮转密钥

  • 主密钥不变,改变加密上下文的内容,进行重新加密。

  • 将主密钥加密的数据或者数据密钥在 KMS 内部使用其它的主密钥进行重新加密。

ReEncrypt 权限设置如下:

  • 需要有操作源主密钥的 kms:ReEncryptFrom 权限。
  • 需要有操作目的主密钥的 kms:ReEncryptTo 权限。
  • 可以设置 kms:ReEncrypt*用于表示上述两个操作的权限。

流控信息

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

授权信息

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

请求参数

字段名称字段详情
CiphertextBlobstring

待转加密的密文。 展开详情

示例值:ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901q********
SourceKeyIdstring

解密密文时使用的主密钥 ID。 展开详情

示例值:5c438b18-05be-40ad-b6c2-3be6752c****
SourceKeyVersionIdstring

用于解密密文的密钥版本标识符。 展开详情

示例值:2ab1a983-7072-4bbc-a582-584b5bd8****
SourceEncryptionAlgorithmstring

CiphertextBlob 是公钥加密结果时,指定公钥加密的算法。算法详情,请参见 AsymmetricDecrypt展开详情

示例值:RSAES_OAEP_SHA_256
SourceEncryptionContextobject

key/value 的 JSON 字符串。如果在 EncryptGenerateDataKeyGenerateDataKeyWithoutPlaintextGenerateAndExportDataKey API 中指定了该参数,则需要提供同样的参数才能解密,详情请参见 EncryptionContext 说明展开详情

示例值:{"Example":"Example"}
DestinationKeyIdstring

对密文解密后再次加密时使用的对称主密钥 ID。

示例值:1234abcd-12ab-34cd-56ef-12345678****
DestinationEncryptionContextobject

key/value 的 JSON 字符串,用于目标主密钥加密时的加密上下文。

示例值:{"Example":"Example"}
DryRunstring

是否开启 DryRun 模式。展开详情

示例值:false

返回参数

字段名称字段详情
KeyIdstring

解密密文使用的主密钥 ID。 展开详情

示例值:2ab1a983-7072-4bbc-a582-584b5bd8****
KeyVersionIdstring

主密钥下用于解密密文的密钥版本标识符。

示例值:202b9877-5a25-46e3-a763-e20791b5****
CiphertextBlobstring

使用指定的主密钥进行再次加密得到的密文。

示例值:DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK****
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

示例值:207596a2-36d3-4840-b1bd-f87044699bd7

返回示例

错误码

全局错误码
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.诊断
500
InternalFailure
Internal Failure.诊断

变更历史

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

相关示例

通过调用 ReEncrypt 接口对密文进行转加密示例
2023-03-29