ExportDataKey - 使用傳入的公開金鑰加密匯出資料密鑰 -

介面說明

注意事項

RAM 使用者或 RAM 角色調用該 OpenAPI 需要被授與權限策略詳情，請參見存取控制。
本介面可以通過共用網關或專屬網關調用。詳細介紹，請參見阿里雲 SDK。
- 共用網關：通過公網、VPC 網域名稱訪問 KMS，該方式需要開啟公網開關。具體操作，請參見通過公網訪問 KMS 執行個體中的密鑰。
- 專屬網關：通過 KMS 私網地址（<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com）訪問 KMS。

詳細說明

調用 GenerateDataKeyWithoutPlaintext 擷取主要金鑰（CMK）加密保護的資料密鑰。當您需要將資料密鑰分發到其它地區（Region）或者密碼模組時，您可以調用 ExportDataKey 介面，返回指定公開金鑰加密資料密鑰的密文。

將公開金鑰加密資料密鑰的密文，匯入到公開金鑰對應私密金鑰所在的密碼模組，可實現 KMS 到密碼模組的密鑰分發，保障了資料密鑰分發過程的安全性。該密鑰匯入到密碼模組後，可用於實現相應資料的加解密運算。

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
CiphertextBlob	string	是	主要金鑰（CMK）加密的資料密鑰的密文。	ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901q********
EncryptionContext	object	否	key/value 的 JSON 字串。EncryptionContext 是使用 CMK 加密資料密鑰時傳入的加密上下文，詳情請參見 EncryptionContext 說明。	{"Example":"Example"}
PublicKeyBlob	string	是	Base64 格式的公開金鑰。	MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAndKfC2ReLL2+y8a0+ZBBeAft/uBYo86GZiYJuflqgUzKxpyuvlo3uQkBv6b+nx+0tz8g8v7GhpPWMSW5L9mNHYsvYFsa7jTxsYdt17yj6GlUHPuMIs8hr5qbwl38IHU1iIa7nYWwE2fb3ePOvLDACRJVgGpU0yxioW80d2QD+9aU4jF5dlAahcfgsNzo2CXzCUc1+xbmNuq7Rp+H9VJB9dyYOwqnW3RhOLBo21FzpORapf0UiRlrHRpk1V6ez+aE1dofaYh/9bh0m6ioxj7j5hpZbWccuEZTMBKd+cbuBkRhJzc6Tti6qwZbDiu4fUwbZS0Tqpuo1UadiyxMW********
WrappingKeySpec	string	是	PublicKeyBlob 的密鑰類型。密鑰類型詳情，請參見非對稱金鑰簡介。取值： RSA_2048 EC_SM2	RSA_2048
WrappingAlgorithm	string	是	使用 PublicKeyBlob 所指定的公開金鑰，加密（Wrap）資料密鑰時的密碼編譯演算法。演算法詳情，請參見 AsymmetricDecrypt 。取值： RSAES_OAEP_SHA_256 RSAES_OAEP_SHA_1 SM2PKE	RSAES_OAEP_SHA_256
DryRun	string	否	是否開啟 DryRun 模式。 true：開啟 false（預設值）：關閉 DryRun 模式用於測試 API 呼叫，驗證您是否具有相應資源的許可權，以及請求參數是否配置正確。DryRun 模式開啟後，KMS 會始終返回失敗並提示失敗原因。失敗原因包含如下： DryRunOperationError：不配置 DryRun 參數時，請求會成功。 ValidationError：請求中指定的參數有誤。 AccessDeniedError：您無權在 KMS 資源上執行該操作。	false

返回參數

名稱	類型	描述	樣本值
	object
KeyVersionId	string	用於解密傳入的資料密鑰密文的密鑰版本標識符。	2ab1a983-7072-4bbc-a582-584b5bd8****
KeyId	string	解密傳入的資料密鑰密文使用的主要金鑰 ID。主要金鑰的通用唯一識別碼。	202b9877-5a25-46e3-a763-e20791b5****
RequestId	string	本次調用請求的 ID，是由阿里雲為該請求產生的唯一識別碼，可用於排查和定位問題。	4bd560a1-729e-45f1-a3d9-b2a33d61046b
ExportedDataKey	string	公開金鑰加密保護匯出的資料密鑰。	BQKP+1zK6+ZEMxTP5qaVzcsgXtWplYBKm0NXdSnB5FzliFxE1bSiu4dnEIlca2JpeH7yz1/S6fed630H+hIH6DoM25fTLNcKj+mFB0Xnh9m2+HN59Mn4qyTfcUeadnfCXSWcGBouhXFwcdd2rJ3n337bzTf4jm659gZu3L0i6PLuxM9p7mqdwO0cKJPfGVfhnfMz+f4alMg79WB/NNyE2lyX7/qxvV49ObNrrJbKSFiz8Djocaf0IESNLMbfYI5bXjWkJlX92DQbKhibtQW8ZOJ//ZC6t0AWcUoKL6QDm/dg5koQalcleRinpB+QadFm894sLbVZ9+N4GVs*******

樣本

正常返回樣本

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*******"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidParameter	The specified parameter is not valid.	參數非法。
500	InternalFailure	Internal Failure.	內部錯誤。建議重試，如果多次重試報錯請提交工單。
404	InvalidAccessKeyId.NotFound	The Access Key ID provided does not exist in our records.

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

變更歷史

更多資訊，參考變更詳情。