Decrypt
更新時間:
解密密文。
注意事項
- 非KMS實(shí)例中的密鑰:進(jìn)行密碼運(yùn)算時,僅支持通過阿里云SDK調(diào)用OpenAPI。
- KMS實(shí)例中的密鑰:進(jìn)行密碼運(yùn)算時,支持如下兩種方式。
- 方式一(推薦):通過KMS實(shí)例SDK調(diào)用KMS實(shí)例API。詳細(xì)介紹,請參見KMS實(shí)例SDK、KMS實(shí)例API。
- 方式二:通過阿里云SDK調(diào)用OpenAPI,但認(rèn)證方式僅支持可信實(shí)體為阿里云服務(wù)的RAM角色。詳細(xì)信息,請參見創(chuàng)建可信實(shí)體為阿里云服務(wù)的RAM角色。
QPS限制
本接口的單用戶QPS限制為750次/秒。超過限制,API調(diào)用將會被限流,這可能影響您的業(yè)務(wù),請合理調(diào)用。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數(shù)
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | Decrypt | 要執(zhí)行的操作。取值:Decrypt。 |
CiphertextBlob | String | 是 | DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK**** | 待解密的密文。 密文可以通過以下API生成: |
EncryptionContext | Map | 否 | {"Example":"Example"} | key/value的JSON字符串。 說明 如果在調(diào)用GenerateDataKey、Encrypt或GenerateDataKeyWithoutPlaintext加密時指定了EncryptionContext,則需要在解密時提供同樣的參數(shù)。更多信息,請參見EncryptionContext說明。 |
DryRun | String | 否 | false | 是否開啟DryRun模式。
DryRun模式用于測試API調(diào)用,驗(yàn)證您是否具有相應(yīng)資源的權(quán)限,以及請求參數(shù)是否配置正確。DryRun模式開啟后,KMS會始終返回失敗并提示失敗原因。失敗原因包含如下:
|
返回數(shù)據(jù)
名稱 |
類型 |
示例值 |
描述 |
KeyVersionId | String | 2ab1a983-7072-4bbc-a582-584b5bd8**** | 主密鑰下用于解密密文的密鑰版本標(biāo)識符。 |
KeyId | String | 202b9877-5a25-46e3-a763-e20791b5**** | 解密密文使用的主密鑰ID。 主密鑰的全局唯一標(biāo)識符。 |
RequestId | String | 207596a2-36d3-4840-b1bd-f87044699bd7 | 本次調(diào)用請求的ID,是由阿里云為該請求生成的唯一標(biāo)識符,可用于排查和定位問題。 |
Plaintext | String | tRYXuCwgja12xxO1N/gZERDDCLw9doZEQiPDk/Bv**** | 解密后的明文。 |
示例
請求示例
http(s)://[Endpoint]/?Action=Decrypt
&CiphertextBlob=DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK****
&DryRun=false
&公共請求參數(shù)
正常返回示例
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. | 請求被拒絕,因?yàn)槊荑€狀態(tài)為已禁用。 |
409 | Rejected.PendingDeletion | The request was rejected because the key state is PendingDeletion. | 請求被拒絕,原因是密鑰狀態(tài)為待刪除。 |
409 | Rejected.Unavailable | The request was rejected because the key state is Unavailable. | 請求被拒絕,原因是密鑰狀態(tài)為不可用。 |
訪問錯誤中心查看更多錯誤碼。
文檔內(nèi)容是否對您有幫助?