用于將明文數據通過KMS密鑰加密為密文。
使用說明
僅當密鑰為KMS軟件密鑰管理實例中的對稱密鑰時，支持使用本接口。關于密鑰規格、加密模式以及密鑰版本的詳細信息，請參見密鑰管理類型和密鑰規格。
AdvanceEncrypt和Encrypt都用于將明文數據加密為密文，區別為：
AdvanceEncrypt：加密時使用密鑰的主版本，加密后需要使用AdvanceDecrypt解密。
Encrypt：加密時使用密鑰的初始版本，加密后可以使用Decrypt或AdvanceDecrypt解密。
如果密鑰開啟了自動輪轉，加密時請使用AdvanceEncrypt，以避免輪轉功能不生效。關于密鑰輪轉的相關內容，請參見密鑰輪轉。
注意事項
所有請求參數使用Protocol Buffers編碼后（即Request Body），內容長度不能超過3 MB，超過3 MB后服務端會拒絕處理并返回HTTP 413狀態碼。建議單次加解密的數據不超過6 KB，超過6 KB時請使用信封加密方案。詳細信息，請參見使用KMS密鑰進行信封加密。
單次加解密的數據量越大，網絡傳輸失敗可能性越大，網絡傳輸所需時間越長，KMS實例對數據進行加解密所需時間也越長。
請求參數
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
KeyId | string | 是 | key-hzz62f1cb66fa42qo**** | 密鑰的全局唯一標識符。該參數也可以被指定為密鑰別名。 重要 密鑰必須為KMS軟件密鑰管理實例中的對稱密鑰。 |
Plaintext | bytes | 是 | 二進制數據 | 待加密的明文數據。 |
Algorithm | string | 否 | AES_GCM | 加密算法。 如果未指定本參數，KMS會使用加密算法默認值。更多信息，請參見密鑰管理類型和密鑰規格。 |
Iv | bytes | 否 | 二進制數據 | 對數據加密時使用的初始向量。 僅當加密算法（Algorithm）為AES_GCM、AES_CBC時本參數有效。
如果未指定本參數，KMS將隨機生成。 重要 推薦您不指定本參數，由KMS隨機生成。 |
Aad | binary | 否 | 二進制數據 | 對數據密鑰加密時使用的GCM加密模式認證數據。 當加密算法（Algorithm）是AES_GCM時，您可以根據業務需要使用本參數。 重要 如果指定了本參數，調用AdvanceDecrypt解密時需要指定相同的參數。 |
PaddingMode | string | 否 | PKCS7_PADDING | 填充模式。 僅當加密算法（Algorithm）為AES_CBC或AES_ECB時，需要指定本參數。 取值：
|
響應數據
名稱 | 類型 | 示例值 | 描述 |
CiphertextBlob | bytes | 二進制數據 | 數據被指定密鑰加密后的密文。 說明 CiphertextBlob中還包含密鑰標識（KeyId）、加密算法（Algorithm）、填充模式（PaddingMode）、加密數據時使用的初始向量（Iv）等信息，通過AdvanceDecrypt解密時僅需傳入CiphertextBlob。 |
Algorithm | string | AES_GCM | 加密算法。 |
KeyId | string | key-hzz62f1cb66fa42qo**** | 密鑰的全局唯一標識符。如果請求中的KeyId參數使用的是密鑰別名，在響應中會返回別名對應的密鑰的全局唯一標識符。 |
KeyVersionId | string | key-hzz62f1cb66fa42qopd9s-17kedv**** | 加密時使用的密鑰版本。本接口使用密鑰當時的主版本。 |
Iv | bytes | 二進制數據 | 加密數據時使用的初始向量。 僅當加密算法（Algorithm）為AES_GCM、AES_CBC時，本參數返回有效值，其他場景返回空值。 |
PaddingMode | string | PKCS7_PADDING | 填充模式。僅當加密算法（Algorithm）為AES_CBC或AES_ECB時，本參數返回有效值，其他場景返回空值。 |
RequestId | string | c0037a6d-7784-4ef2-a692-288fdefc7b9d | 本次調用請求的ID，是由阿里云為該請求生成的唯一標識符，可用于排查和定位問題。 |
錯誤碼
HTTP狀態碼 | 錯誤碼 | 錯誤消息 | 描述 |
404 | Forbidden.OnlySymmetricKeySupported | The key %s is not a symmetric key. The API only supports symmetric keys. | 僅支持使用對稱密鑰。 說明 非對稱加密一般用于跨安全域的數據加密或密鑰交換，這意味著通常有一端不使用阿里云KMS。 |
訪問公共錯誤碼查看更多錯誤碼。