調用AsymmetricEncrypt接口使用非對稱密鑰進行加密。
注意事項
- 非KMS實例中的密鑰：進行密碼運算時，僅支持通過阿里云SDK調用OpenAPI。
- KMS實例中的密鑰：進行密碼運算時，支持如下兩種方式。
- 方式一（推薦）：通過KMS實例SDK調用KMS實例API。詳細介紹，請參見KMS實例SDK、KMS實例API。
- 方式二：通過阿里云SDK調用OpenAPI，但認證方式僅支持可信實體為阿里云服務的RAM角色。詳細信息，請參見創建可信實體為阿里云服務的RAM角色。
QPS限制
本接口的單用戶QPS限制為200次/秒。超過限制，API調用將會被限流，這可能影響您的業務，請合理調用。
詳細說明
僅支持Usage為ENCRYPT/DECRYPT的非對稱密鑰。支持的加密算法如下表：
KeySpec |
Algorithm |
說明 |
可加密的最大字節數 |
RSA_2048 |
RSAES_OAEP_SHA_256 |
RSAES-OAEP using SHA-256 and MGF1 with SHA-256 |
190 |
RSA_2048 |
RSAES_OAEP_SHA_1 |
RSAES-OAEP using SHA1 and MGF1 with SHA1 |
214 |
RSA_3072 |
RSAES_OAEP_SHA_256 |
RSAES-OAEP using SHA-256 and MGF1 with SHA-256 |
318 |
RSA_3072 |
RSAES_OAEP_SHA_1 |
RSAES-OAEP using SHA1 and MGF1 with SHA1 |
342 |
EC_SM2 |
SM2PKE |
SM2橢圓曲線公鑰加密算法 |
6047 |
本文將提供一個示例，使用密鑰ID為key-hzz630494463ejqjx****
、密鑰版本ID為2ab1a983-7072-4bbc-a582-584b5bd8****的非對稱密鑰，通過加密算法RSAES_OAEP_SHA_1對明文SGVsbG8gd29ybGQ=進行加密。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
|
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
| Action | String | 是 | AsymmetricEncrypt | 要執行的操作。取值：AsymmetricEncrypt。 |
| Plaintext | String | 是 | SGVsbG8gd29ybGQ= | 要加密的明文，使用Base64編碼。 |
| KeyId | String | 是 | key-hzz630494463ejqjx**** | 密鑰的ID，也可以指定為密鑰別名或密鑰資源名稱（ARN）。關于別名的詳細介紹，請參見管理密鑰別名。 說明 訪問其他阿里云賬號下的密鑰時，必須輸入密鑰ARN。密鑰ARN的格式為 acs:kms:${region}:${account}:key/${keyid}。 |
| KeyVersionId | String | 是 | 2ab1a983-7072-4bbc-a582-584b5bd8**** | 密鑰版本ID。密鑰版本的全局唯一標識符。 說明 您可以調用ListKeyVersions接口獲取KeyVersionId（密鑰版本ID）。 |
| Algorithm | String | 是 | RSAES_OAEP_SHA_1 | 加密算法。 |
| DryRun | String | 否 | false | 是否開啟DryRun模式。
DryRun模式用于測試API調用，驗證您是否具有相應資源的權限，以及請求參數是否配置正確。DryRun模式開啟后，KMS會始終返回失敗并提示失敗原因。失敗原因包含如下：
|
返回數據
名稱 |
類型 |
示例值 |
描述 |
| KeyVersionId | String | 2ab1a983-7072-4bbc-a582-584b5bd8**** | 對明文數據進行加密的主密鑰版本號。 |
| KeyId | String | key-hzz630494463ejqjx**** | 密鑰ID。如果請求中的KeyId參數使用的是密鑰別名、密鑰ARN，在響應中也會返回密鑰ID。 |
| CiphertextBlob | String | BQKP+1zK6+ZEMxTP5qaVzcsgXtWplYBKm0NXdSnB5FzliFxE1bSiu4dnEIlca2JpeH7yz1/S6fed630H+hIH6DoM25fTLNcKj+mFB0Xnh9m2+HN59Mn4qyTfcUeadnfCXSWcGBouhXFwcdd2rJ3n337bzTf4jm659gZu3L0i6PLuxM9p7mqdwO0cKJPfGVfhnfMz+f4alMg79WB/NNyE2lyX7/qxvV49ObNrrJbKSFiz8Djocaf0IESNLMbfYI5bXjWkJlX92DQbKhibtQW8ZOJ//ZC6t0AWcUoKL6QDm/dg5koQalcleRinpB+QadFm894sLbVZ9+N4GVsv1Wbjwg== | 加密后的密文，使用Base64編碼。 |
| RequestId | String | 475f1620-b9d3-4d35-b5c6-3fbdd941423d | 本次調用請求的ID，是由阿里云為該請求生成的唯一標識符，可用于排查和定位問題。 |
示例
請求示例
http(s)://[Endpoint]/?Action=AsymmetricEncrypt
&Plaintext=SGVsbG8gd29ybGQ=
&KeyId=key-hzz630494463ejqjx****
&KeyVersionId=2ab1a983-7072-4bbc-a582-584b5bd8****
&Algorithm=RSAES_OAEP_SHA_1
&DryRun=false
&公共請求參數正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<AsymmetricEncryptResponse>
<KeyVersionId>2ab1a983-7072-4bbc-a582-584b5bd8****</KeyVersionId>
<KeyId>key-hzz630494463ejqjx****</KeyId>
<CiphertextBlob>BQKP+1zK6+ZEMxTP5qaVzcsgXtWplYBKm0NXdSnB5FzliFxE1bSiu4dnEIlca2JpeH7yz1/S6fed630H+hIH6DoM25fTLNcKj+mFB0Xnh9m2+HN59Mn4qyTfcUeadnfCXSWcGBouhXFwcdd2rJ3n337bzTf4jm659gZu3L0i6PLuxM9p7mqdwO0cKJPfGVfhnfMz+f4alMg79WB/NNyE2lyX7/qxvV49ObNrrJbKSFiz8Djocaf0IESNLMbfYI5bXjWkJlX92DQbKhibtQW8ZOJ//ZC6t0AWcUoKL6QDm/dg5koQalcleRinpB+QadFm894sLbVZ9+N4GVsv1Wbjwg==</CiphertextBlob>
<RequestId>475f1620-b9d3-4d35-b5c6-3fbdd941423d</RequestId>
</AsymmetricEncryptResponse>JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"KeyVersionId" : "2ab1a983-7072-4bbc-a582-584b5bd8****",
"KeyId" : "key-hzz630494463ejqjx****",
"CiphertextBlob" : "BQKP+1zK6+ZEMxTP5qaVzcsgXtWplYBKm0NXdSnB5FzliFxE1bSiu4dnEIlca2JpeH7yz1/S6fed630H+hIH6DoM25fTLNcKj+mFB0Xnh9m2+HN59Mn4qyTfcUeadnfCXSWcGBouhXFwcdd2rJ3n337bzTf4jm659gZu3L0i6PLuxM9p7mqdwO0cKJPfGVfhnfMz+f4alMg79WB/NNyE2lyX7/qxvV49ObNrrJbKSFiz8Djocaf0IESNLMbfYI5bXjWkJlX92DQbKhibtQW8ZOJ//ZC6t0AWcUoKL6QDm/dg5koQalcleRinpB+QadFm894sLbVZ9+N4GVsv1Wbjwg==",
"RequestId" : "475f1620-b9d3-4d35-b5c6-3fbdd941423d"
}錯誤碼
|
HttpCode |
錯誤碼 |
錯誤信息 |
描述 |
| 400 | Rejected.UnsupportedOperation | Unsupported operation. | 不支持的操作 |
| 404 | Forbidden.AliasNotFound | The specified Alias is not found. | 指定的別名找不到 |
| 404 | Forbidden.KeyNotFound | The specified Key is not found. | 指定的密鑰不存在。 |
訪問錯誤中心查看更多錯誤碼。