使用對稱金鑰將明文加密為密文。
介面說明
注意事項
-
RAM 使用者或 RAM 角色調用該 OpenAPI 需要被授與權限策略詳情，請參見存取控制。
-
本介面可以通過共用網關或專屬網關調用。詳細介紹，請參見阿里雲 SDK。
共用網關：通過公網、VPC 網域名稱訪問 KMS，該方式需要開啟公網開關。具體操作，請參見通過公網訪問 KMS 執行個體中的密鑰。
專屬網關：通過 KMS 私網地址（
<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com）訪問 KMS。
QPS 限制
通過共用網關調用：本介面的單使用者 QPS 限制為 1000 次/秒。超過限制，API 呼叫將會被限流，這可能影響您的業務，請合理調用。
通過專屬網關調用：本介面的單使用者 QPS 限制以您 KMS 執行個體的計算效能規格為準。詳細介紹，請參見效能資料。
詳細說明
KMS 使用指定密鑰的主要版本對傳入資料進行加密。
最多可加密 6KB 的資料，例如 RSA 密鑰、資料庫密碼或其它敏感資訊。
如果將加密資料從一個地區遷移到另一個地區，可以調用 Encrypt 介面在新地區中加密從另一個地區中轉移過來的明文 DataKey。新地區中會產生一個加密後的 DataKey。您可以在新地區調用 Decrypt 將其解密。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| KeyId |
string |
是 |
密鑰的 ID，也可以指定為密鑰別名或密鑰資源名稱（ARN）。關於別名的詳細介紹，請參見管理密鑰別名。 說明
訪問其他阿里雲帳號下的密鑰時，必須輸入密鑰 ARN。密鑰 ARN 的格式為 |
key-hzz630494463ejqjx**** |
| Plaintext |
string |
是 |
待加密明文（必須經過 Base 64 編碼）。 |
SGVsbG8gd29y**** |
| EncryptionContext |
object |
否 |
key/value 的 JSON 字串。如果指定了該參數，則在調用 Decrypt 時需要提供同樣的參數，詳情請參見 EncryptionContext 說明。 |
{"Example":"Example"} |
| DryRun |
string |
否 |
是否開啟 DryRun 模式。
DryRun 模式用於測試 API 呼叫，驗證您是否具有相應資源的許可權，以及請求參數是否配置正確。請根據返回訊息查看驗證結果。
|
false |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| KeyVersionId |
string |
用於加密明文的密鑰版本標誌符。是指定密鑰的主要版本。 |
86a9efd9-3d16-4894-bd4f-1fc43f3f**** |
| KeyId |
string |
金鑰識別碼。如果請求中的 KeyId 參數使用的是密鑰別名、密鑰 ARN，在響應中會返回金鑰識別碼。 |
key-hzz630494463ejqjx**** |
| CiphertextBlob |
string |
資料被指定密鑰的主要版本加密後的密文。 |
DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK**** |
| RequestId |
string |
本次調用請求的 ID，是由阿里雲為該請求產生的唯一識別碼，可用於排查和定位問題。 |
475f1620-b9d3-4d35-b5c6-3fbdd941423d |
樣本
正常返回樣本
JSON格式
{
"KeyVersionId": "86a9efd9-3d16-4894-bd4f-1fc43f3f****",
"KeyId": "key-hzz630494463ejqjx****",
"CiphertextBlob": "DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK****",
"RequestId": "475f1620-b9d3-4d35-b5c6-3fbdd941423d"
}錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter | The specified parameter is invalid. | 參數錯誤 |
| 404 | Forbidden.KeyNotFound | The specified Key is not found. | 指定的密鑰不存在。 |
| 404 | Forbidden.AliasNotFound | The specified Alias is not found. | 指定的別名找不到 |
| 404 | InvalidAccessKeyId.NotFound | The Access Key ID provided does not exist in our records. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。