全部产品
Search

搜索本产品

    密钥管理服务：Decrypt

    文档中心

    密钥管理服务：Decrypt

    更新时间：Aug 27, 2024

    解密密文。

    注意事项

    • 非KMS实例中的密钥：进行密码运算时，仅支持通过阿里云SDK调用OpenAPI。
    • KMS实例中的密钥：进行密码运算时，支持如下两种方式。

    QPS限制

    本接口的单用户QPS限制为750次/秒。超过限制，API调用将会被限流，这可能影响您的业务，请合理调用。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    请求参数

    名称

    类型

    是否必选

    示例值

    描述
    Action String 是 Decrypt

    要执行的操作。取值：Decrypt。
    CiphertextBlob String 是 DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK****

    待解密的密文。

    密文可以通过以下API生成：
    EncryptionContext Map 否 {"Example":"Example"}

    key/value的JSON字符串。

    说明 如果在调用GenerateDataKey、Encrypt或GenerateDataKeyWithoutPlaintext加密时指定了EncryptionContext，则需要在解密时提供同样的参数。更多信息，请参见EncryptionContext说明。
    DryRun String 否 false

    是否开启DryRun模式。

    • true：开启
    • false（默认值）：关闭

    DryRun模式用于测试API调用，验证您是否具有相应资源的权限，以及请求参数是否配置正确。DryRun模式开启后，KMS会始终返回失败并提示失败原因。失败原因包含如下：

    • DryRunOperationError：不配置DryRun参数时，请求会成功。
    • ValidationError：请求中指定的参数有误。
    • AccessDeniedError：您无权在KMS资源上执行该操作。

    返回数据

    名称

    类型

    示例值

    描述
    KeyVersionId String 2ab1a983-7072-4bbc-a582-584b5bd8****

    主密钥下用于解密密文的密钥版本标识符。
    KeyId String 202b9877-5a25-46e3-a763-e20791b5****

    解密密文使用的主密钥ID。

    主密钥的全局唯一标识符。
    RequestId String 207596a2-36d3-4840-b1bd-f87044699bd7

    本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。
    Plaintext String tRYXuCwgja12xxO1N/gZERDDCLw9doZEQiPDk/Bv****

    解密后的明文。

    示例

    请求示例

    http(s)://[Endpoint]/?Action=Decrypt
&CiphertextBlob=DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK****
&DryRun=false
&公共请求参数

    正常返回示例

    XML格式

    HTTP/1.1 200 OK
Content-Type:application/xml

<DecryptResponse>
    <KeyVersionId>2ab1a983-7072-4bbc-a582-584b5bd8****</KeyVersionId>
    <KeyId>202b9877-5a25-46e3-a763-e20791b5****</KeyId>
    <RequestId>207596a2-36d3-4840-b1bd-f87044699bd7</RequestId>
    <Plaintext>tRYXuCwgja12xxO1N/gZERDDCLw9doZEQiPDk/Bv****</Plaintext>
</DecryptResponse>

    JSON格式

    HTTP/1.1 200 OK
Content-Type:application/json

{
  "KeyVersionId" : "2ab1a983-7072-4bbc-a582-584b5bd8****",
  "KeyId" : "202b9877-5a25-46e3-a763-e20791b5****",
  "RequestId" : "207596a2-36d3-4840-b1bd-f87044699bd7",
  "Plaintext" : "tRYXuCwgja12xxO1N/gZERDDCLw9doZEQiPDk/Bv****"
}

    错误码

    HttpCode

    错误码

    错误信息

    描述
    400 UnsupportedOperation This action is not supported. 不支持的操作
    404 Forbidden.AliasNotFound The specified Alias is not found. 指定的别名找不到
    404 Forbidden.KeyNotFound The specified Key is not found. 指定的密钥不存在。
    409 Rejected.Disabled The request was rejected because the key state is Disabled. 请求被拒绝，因为密钥状态为已禁用。
    409 Rejected.PendingDeletion The request was rejected because the key state is PendingDeletion. 请求被拒绝，原因是密钥状态为待删除。
    409 Rejected.Unavailable The request was rejected because the key state is Unavailable. 请求被拒绝，原因是密钥状态为不可用。

    访问错误中心查看更多错误码。