生成一個隨機的數據密鑰。可以用數據密鑰進行本地數據的加密。
注意事項
- 非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 | 指定生成的數據密鑰的長度，取值：
說明 建議使用KeySpec或者NumberOfBytes來指定數據密鑰長度。如果兩者都不指定，KMS生成256位的數據密鑰；如果兩者都被指定，KMS會忽略KeySpec參數。 |
| NumberOfBytes | Integer | 否 | 256 | 指定生成的數據密鑰的長度。 取值：1~1024。 單位：字節 |
| EncryptionContext | Map | 否 | {"Example":"Example"} | key/value對的JSON字符串，如果指定了該參數，則在調用Decrypt 時需要提供同樣的參數，詳情請參見EncryptionContext說明。 |
| DryRun | String | 否 | false | 是否開啟DryRun模式。
DryRun模式用于測試API調用，驗證您是否具有相應資源的權限，以及請求參數是否配置正確。DryRun模式開啟后，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. | 指定的密鑰不存在。 |
訪問錯誤中心查看更多錯誤碼。