解密密文。
介面說明
注意事項
-
RAM 使用者或 RAM 角色呼叫該 OpenAPI 需要被授予的權限策略詳情,請參見存取控制。
-
本介面可以透過共享閘道器或專屬閘道器呼叫。詳細介紹,請參見阿里雲 SDK。
共享閘道器:透過公網、VPC 網域存取 KMS,該方式需要開啟公網開關。具體操作,請參見透過公網存取 KMS 執行個體中的金鑰。
專屬閘道器:透過 KMS 私網地址(
<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com)存取 KMS。
QPS 限制
透過共享閘道器呼叫:本介面的單一使用者 QPS 限制為 1000 次/秒。超過限制,API 呼叫將會被限流,這可能影響您的業務,請合理呼叫。
透過專屬閘道器呼叫:本介面的單一使用者 QPS 限制以您 KMS 執行個體的運算效能規格為準。詳細介紹,請參見效能資料。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| CiphertextBlob |
string |
是 |
待解密的密文。 |
DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK**** |
| EncryptionContext |
object |
否 |
key/value 的 JSON 字串。 說明
如果在呼叫 GenerateDataKey 、 Encrypt 或 GenerateDataKeyWithoutPlaintext 加密時指定了 EncryptionContext,則需要在解密時提供同樣的參數。更多資訊,請參見 EncryptionContext 說明。 |
{"Example":"Example"} |
| DryRun |
string |
否 |
是否開啟 DryRun 模式。
DryRun 模式用於測試 API 呼叫,驗證您是否具有相應資源的權限,以及請求參數是否設定正確。DryRun 模式開啟後,KMS 會始終傳回失敗並提示失敗原因。失敗原因包含如下:
|
false |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| KeyVersionId |
string |
主金鑰下用於解密密文的金鑰版本識別碼。 |
2ab1a983-7072-4bbc-a582-584b5bd8**** |
| KeyId |
string |
解密密文使用的主金鑰 ID。 |
202b9877-5a25-46e3-a763-e20791b5**** |
| RequestId |
string |
本次呼叫請求的 ID,是由阿里雲為該請求產生的唯一識別碼,可用於疑難排解與定位問題。 |
207596a2-36d3-4840-b1bd-f87044699bd7 |
| Plaintext |
string |
解密後的明文。 |
tRYXuCwgja12xxO1N/gZERDDCLw9doZEQiPDk/Bv**** |
| CiphertextForRecipient |
string |
NIahY6pgjK4ZMP2R0EmsmBqntrv0AI2rcDyU7Su6uOT9Le7EOvlCpjHJfr9z3M0vkfulQoyuETmKSpYDfixE3auE4MwxloT6D9Gfsk6hm5FV2iAxL//Ms2kLv6K4z6yGi7lKm2yjX4***== |
樣本
正常返回樣本
JSON格式
{
"KeyVersionId": "2ab1a983-7072-4bbc-a582-584b5bd8****",
"KeyId": "202b9877-5a25-46e3-a763-e20791b5****",
"RequestId": "207596a2-36d3-4840-b1bd-f87044699bd7",
"Plaintext": "tRYXuCwgja12xxO1N/gZERDDCLw9doZEQiPDk/Bv****",
"CiphertextForRecipient": "NIahY6pgjK4ZMP2R0EmsmBqntrv0AI2rcDyU7Su6uOT9Le7EOvlCpjHJfr9z3M0vkfulQoyuETmKSpYDfixE3auE4MwxloT6D9Gfsk6hm5FV2iAxL//Ms2kLv6K4z6yGi7lKm2yjX4***==\n"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 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. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。