解密密文。
介面說明
注意事項
-
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**** |
樣本
正常返回樣本
JSON格式
{
"KeyVersionId": "2ab1a983-7072-4bbc-a582-584b5bd8****",
"KeyId": "202b9877-5a25-46e3-a763-e20791b5****",
"RequestId": "207596a2-36d3-4840-b1bd-f87044699bd7",
"Plaintext": "tRYXuCwgja12xxO1N/gZERDDCLw9doZEQiPDk/Bv****"
}錯誤碼
|
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. | 請求被拒絕，原因是密鑰狀態為不可用。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。