Decrypt - - 阿里雲

注意事項

非KMS執行個體中的密鑰：進行密碼運算時，僅支援通過阿里雲SDK調用OpenAPI。
KMS執行個體中的密鑰：進行密碼運算時，支援如下兩種方式。
- 方式一（推薦）：通過KMS執行個體SDK調用KMS執行個體API。詳細介紹，請參見KMS執行個體SDK、KMS執行個體API。
- 方式二：通過阿里雲SDK調用OpenAPI，但認證方式僅支援可信實體為阿里雲服務的RAM角色。詳細資料，請參見建立可信實體為阿里雲服務的RAM角色。

QPS限制

本介面的單使用者QPS限制為750次/秒。超過限制，API調用將會被限流，這可能影響您的業務，請合理調用。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	Decrypt	要執行的操作。取值：Decrypt。
CiphertextBlob	String	是	DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK****	待解密的密文。密文可以通過以下API產生： GenerateDataKey Encrypt GenerateDataKeyWithoutPlaintext
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.	請求被拒絕，原因是密鑰狀態為不可用。

訪問錯誤中心查看更多錯誤碼。