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