調用ExportDataKey接口使用傳入的公鑰加密導出數據密鑰。
注意事項
- 非KMS實例中的密鑰：進行密碼運算時，僅支持通過阿里云SDK調用OpenAPI。
- KMS實例中的密鑰：進行密碼運算時，支持如下兩種方式。
- 方式一（推薦）：通過KMS實例SDK調用KMS實例API。詳細介紹，請參見KMS實例SDK、KMS實例API。
- 方式二：通過阿里云SDK調用OpenAPI，但認證方式僅支持可信實體為阿里云服務的RAM角色。詳細信息，請參見創建可信實體為阿里云服務的RAM角色。
QPS限制
本接口的單用戶QPS限制為750次/秒。超過限制，API調用將會被限流，這可能影響您的業務，請合理調用。
詳細說明
調用GenerateDataKeyWithoutPlaintext獲取主密鑰（CMK）加密保護的數據密鑰。當您需要將數據密鑰分發到其它地域（Region）或者密碼模塊時，您可以調用ExportDataKey接口，返回指定公鑰加密數據密鑰的密文。
將公鑰加密數據密鑰的密文，導入到公鑰對應私鑰所在的密碼模塊，可實現KMS到密碼模塊的密鑰分發，保障了數據密鑰分發過程的安全性。該密鑰導入到密碼模塊后，可用于實現相應數據的加解密運算。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
|
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
| Action | String | 是 | ExportDataKey | 系統規定參數。取值：ExportDataKey。 |
| CiphertextBlob | String | 是 | ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901q******** | 主密鑰（CMK）加密的數據密鑰的密文。 |
| EncryptionContext | Map | 否 | {"Example":"Example"} | key/value的JSON字符串。EncryptionContext是使用CMK加密數據密鑰時傳入的加密上下文，詳情請參見EncryptionContext說明。 |
| PublicKeyBlob | String | 是 | MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAndKfC2ReLL2+y8a0+ZBBeAft/uBYo86GZiYJuflqgUzKxpyuvlo3uQkBv6b+nx+0tz8g8v7GhpPWMSW5L9mNHYsvYFsa7jTxsYdt17yj6GlUHPuMIs8hr5qbwl38IHU1iIa7nYWwE2fb3ePOvLDACRJVgGpU0yxioW80d2QD+9aU4jF5dlAahcfgsNzo2CXzCUc1+xbmNuq7Rp+H9VJB9dyYOwqnW3RhOLBo21FzpORapf0UiRlrHRpk1V6ez+aE1dofaYh/9bh0m6ioxj7j5hpZbWccuEZTMBKd+cbuBkRhJzc6Tti6qwZbDiu4fUwbZS0Tqpuo1UadiyxMW******** | Base64格式的公鑰。 |
| WrappingKeySpec | String | 是 | RSA_2048 | PublicKeyBlob的密鑰類型。密鑰類型詳情，請參見非對稱密鑰簡介。 取值：
|
| WrappingAlgorithm | String | 是 | RSAES_OAEP_SHA_256 | 使用PublicKeyBlob所指定的公鑰，加密（Wrap）數據密鑰時的加密算法。算法詳情，請參見AsymmetricDecrypt。 取值：
|
| DryRun | String | 否 | false | 是否開啟DryRun模式。
DryRun模式用于測試API調用，驗證您是否具有相應資源的權限，以及請求參數是否配置正確。DryRun模式開啟后，KMS會始終返回失敗并提示失敗原因。失敗原因包含如下：
|
返回數據
名稱 |
類型 |
示例值 |
描述 |
| KeyVersionId | String | 2ab1a983-7072-4bbc-a582-584b5bd8**** | 用于解密傳入的數據密鑰密文的密鑰版本標識符。 |
| KeyId | String | 202b9877-5a25-46e3-a763-e20791b5**** | 解密傳入的數據密鑰密文使用的主密鑰ID。 主密鑰的全局唯一標識符。 |
| RequestId | String | 4bd560a1-729e-45f1-a3d9-b2a33d61046b | 本次調用請求的ID，是由阿里云為該請求生成的唯一標識符，可用于排查和定位問題。 |
| ExportedDataKey | String | BQKP+1zK6+ZEMxTP5qaVzcsgXtWplYBKm0NXdSnB5FzliFxE1bSiu4dnEIlca2JpeH7yz1/S6fed630H+hIH6DoM25fTLNcKj+mFB0Xnh9m2+HN59Mn4qyTfcUeadnfCXSWcGBouhXFwcdd2rJ3n337bzTf4jm659gZu3L0i6PLuxM9p7mqdwO0cKJPfGVfhnfMz+f4alMg79WB/NNyE2lyX7/qxvV49ObNrrJbKSFiz8Djocaf0IESNLMbfYI5bXjWkJlX92DQbKhibtQW8ZOJ//ZC6t0AWcUoKL6QDm/dg5koQalcleRinpB+QadFm894sLbVZ9+N4GVs******* | 公鑰加密保護導出的數據密鑰。 |
示例
請求示例
http(s)://[Endpoint]/?Action=ExportDataKey
&CiphertextBlob=ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901q********
&PublicKeyBlob=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAndKfC2ReLL2+y8a0+ZBBeAft/uBYo86GZiYJuflqgUzKxpyuvlo3uQkBv6b+nx+0tz8g8v7GhpPWMSW5L9mNHYsvYFsa7jTxsYdt17yj6GlUHPuMIs8hr5qbwl38IHU1iIa7nYWwE2fb3ePOvLDACRJVgGpU0yxioW80d2QD+9aU4jF5dlAahcfgsNzo2CXzCUc1+xbmNuq7Rp+H9VJB9dyYOwqnW3RhOLBo21FzpORapf0UiRlrHRpk1V6ez+aE1dofaYh/9bh0m6ioxj7j5hpZbWccuEZTMBKd+cbuBkRhJzc6Tti6qwZbDiu4fUwbZS0Tqpuo1UadiyxMW********
&WrappingKeySpec=RSA_2048
&WrappingAlgorithm=RSAES_OAEP_SHA_256
&DryRun=false
&公共請求參數正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ExportDataKeyResponse>
<KeyVersionId>2ab1a983-7072-4bbc-a582-584b5bd8****</KeyVersionId>
<KeyId>202b9877-5a25-46e3-a763-e20791b5****</KeyId>
<RequestId>4bd560a1-729e-45f1-a3d9-b2a33d61046b</RequestId>
<ExportedDataKey>BQKP+1zK6+ZEMxTP5qaVzcsgXtWplYBKm0NXdSnB5FzliFxE1bSiu4dnEIlca2JpeH7yz1/S6fed630H+hIH6DoM25fTLNcKj+mFB0Xnh9m2+HN59Mn4qyTfcUeadnfCXSWcGBouhXFwcdd2rJ3n337bzTf4jm659gZu3L0i6PLuxM9p7mqdwO0cKJPfGVfhnfMz+f4alMg79WB/NNyE2lyX7/qxvV49ObNrrJbKSFiz8Djocaf0IESNLMbfYI5bXjWkJlX92DQbKhibtQW8ZOJ//ZC6t0AWcUoKL6QDm/dg5koQalcleRinpB+QadFm894sLbVZ9+N4GVs*******</ExportedDataKey>
</ExportDataKeyResponse>JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"KeyVersionId" : "2ab1a983-7072-4bbc-a582-584b5bd8****",
"KeyId" : "202b9877-5a25-46e3-a763-e20791b5****",
"RequestId" : "4bd560a1-729e-45f1-a3d9-b2a33d61046b",
"ExportedDataKey" : "BQKP+1zK6+ZEMxTP5qaVzcsgXtWplYBKm0NXdSnB5FzliFxE1bSiu4dnEIlca2JpeH7yz1/S6fed630H+hIH6DoM25fTLNcKj+mFB0Xnh9m2+HN59Mn4qyTfcUeadnfCXSWcGBouhXFwcdd2rJ3n337bzTf4jm659gZu3L0i6PLuxM9p7mqdwO0cKJPfGVfhnfMz+f4alMg79WB/NNyE2lyX7/qxvV49ObNrrJbKSFiz8Djocaf0IESNLMbfYI5bXjWkJlX92DQbKhibtQW8ZOJ//ZC6t0AWcUoKL6QDm/dg5koQalcleRinpB+QadFm894sLbVZ9+N4GVs*******"
}錯誤碼
|
HttpCode |
錯誤碼 |
錯誤信息 |
描述 |
| 400 | InvalidParameter | The specified parameter is not valid. | 參數非法。 |
| 500 | InternalFailure | Internal Failure. | 內部錯誤。建議重試，如果多次重試報錯請提交工單。 |
訪問錯誤中心查看更多錯誤碼。
文檔內容是否對您有幫助？