GenerateDataKeyWithoutPlaintext -

注意事項

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

QPS限制

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

詳細說明

此API隨機產生一個資料密鑰，並通過您指定的對稱主要金鑰（Symmetric CMK）加密後，返回資料密鑰的密文。此API和GenerateDataKey提供完全相同的功能，唯一的區別是此API不會返回資料密鑰的明文。

您在請求中指定的CMK，僅用於資料密鑰的加密，不會用於資料密鑰的產生。KMS不會記錄或儲存隨機產生的資料密鑰。

說明

此API適用於不需要立即使用資料密鑰完成資料加密的系統。系統需要加密時，通過調用Decrypt介面解開資料密鑰的密文。
此API也適用於具有不同信任等級的分布式系統。例如：您的系統將資料按照既定劃分策略儲存到不同的分區中。其中的一個模組會預先建立不同的資料分區，對每一個分區分別產生不同的資料密鑰。這一模組完成控制平面的初始化之後，並不參與資料的生產和消費，它是密鑰分發者。而資料平面的模組，在產生和消費資料的時候，首先擷取分區的資料密鑰密文，在解開之後使用資料密鑰的明文對資料執行加密或者解密操作，隨後清除記憶體中的資料密鑰明文。在這樣的系統中，密鑰分發者不需要擷取到資料密鑰的明文，只需要使用相關CMK的GenerateDataKeyWithoutPlaintext的許可權；而資料的生產和消費者，不需要產生新的資料密鑰，只需要使用相關CMK的Decrypt的許可權。

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	GenerateDataKeyWithoutPlaintext	系統規定參數。取值：GenerateDataKeyWithoutPlaintext。
KeyId	String	是	599fa825-17de-417e-9554-bb032cc6****	主要金鑰（CMK）的通用唯一識別碼。該參數也可以被指定為CMK綁定的別名，詳情請參見別名使用說明。
KeySpec	String	否	AES_256	指定產生的資料密鑰的長度，取值： AES_256：256位的對稱金鑰 AES_128：128位的對稱金鑰說明建議使用KeySpec或者NumberOfBytes來指定資料密鑰長度。如果兩者都不指定，KMS產生256位的資料密鑰；如果兩者都被指定，KMS會忽略KeySpec參數。
NumberOfBytes	Integer	否	256	指定產生的資料密鑰的長度。取值：1~1024。單位：位元組
EncryptionContext	Map	否	{"Example":"Example"}	key/value對的JSON字串，如果指定了該參數，則在調用Decrypt 時需要提供同樣的參數，詳情請參見EncryptionContext說明。
DryRun	String	否	false	是否開啟DryRun模式。 true：開啟 false（預設值）：關閉 DryRun模式用於測試API調用，驗證您是否具有相應資源的許可權，以及請求參數是否配置正確。DryRun模式開啟後，KMS會始終返回失敗並提示失敗原因。失敗原因包含如下： DryRunOperationError：不配置DryRun參數時，請求會成功。 ValidationError：請求中指定的參數有誤。 AccessDeniedError：您無權在KMS資源上執行該操作。

返回資料

名稱	類型	樣本值	描述
KeyVersionId	String	2ab1a983-7072-4bbc-a582-584b5bd8****	用於加密明文的密鑰版本標誌符。是指定CMK的主要版本。
KeyId	String	599fa825-17de-417e-9554-bb032cc6****	CMK的通用唯一識別碼。說明如果請求中的KeyId參數使用的是CMK的別名，在響應中會返回別名對應的CMK標誌符。
CiphertextBlob	String	ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS****	資料密鑰被指定CMK的主要版本加密後的密文。
RequestId	String	7021b6ec-4be7-4d3c-8a68-1e85d4d515a0	本次調用請求的ID，是由阿里雲為該請求產生的唯一識別碼，可用於排查和定位問題。

樣本

請求樣本

http(s)://[Endpoint]/?Action=GenerateDataKeyWithoutPlaintext
&KeyId=1234abcd-12ab-34cd-56ef-12345678****
&KeySpec=AES_256
&NumberOfBytes=256
&DryRun=false
&公用請求參數

正常返回樣本

XML格式

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

<GenerateDataKeyWithoutPlaintextResponse>
    <KeyVersionId>2ab1a983-7072-4bbc-a582-584b5bd8****</KeyVersionId>
    <KeyId>599fa825-17de-417e-9554-bb032cc6****</KeyId>
    <CiphertextBlob>ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS****</CiphertextBlob>
    <RequestId>7021b6ec-4be7-4d3c-8a68-1e85d4d515a0</RequestId>
</GenerateDataKeyWithoutPlaintextResponse>

JSON格式

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

{
  "KeyVersionId" : "2ab1a983-7072-4bbc-a582-584b5bd8****",
  "KeyId" : "599fa825-17de-417e-9554-bb032cc6****",
  "CiphertextBlob" : "ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS****",
  "RequestId" : "7021b6ec-4be7-4d3c-8a68-1e85d4d515a0"
}

錯誤碼

HttpCode	錯誤碼	錯誤資訊	描述
400	InvalidParameter	The specified parameter is not valid.	參數非法。
404	Forbidden.KeyNotFound	The specified Key is not found.	指定的密鑰不存在。

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