全部產品

Key Management Service：API概覽

更新時間：Jul 06, 2024

本文介紹KMS執行個體API提供的API介面及相關描述。

密鑰介面

使用KMS提供的密鑰介面前，請關注以下資訊：

AdvanceEncrypt、AdvanceDecrypt、AdvanceGenerateDataKey和GenerateDataKey：KMS密鑰應為對稱金鑰。
Encrypt和Decrypt：KMS密鑰可以為對稱金鑰，也可以為非對稱金鑰。
Sign、Verify和GetPublicKey：KMS密鑰應為非對稱金鑰。

API	描述
AdvanceEncrypt	用於將明文資料通過KMS祕密金鑰加密為密文。重要如果密鑰開啟了自動輪轉，請您使用AdvanceEncrypt、AdvanceDecrypt和AdvanceGenerateDataKey介面，以避免輪轉功能不生效。關於密鑰輪轉的相關內容，請參見密鑰輪轉。您需要儲存密文（CiphertextBlob）和認證資料（Aad），然後使用AdvanceDecrypt解密。
AdvanceDecrypt	將使用KMS祕密金鑰加密的密文解密為明文。
AdvanceGenerateDataKey	用於產生資料密鑰，對資料按照KMS信封加密方式加密。重要您需要儲存密文（CiphertextBlob）和認證資料（Aad），然後使用AdvanceDecrypt解密。
Encrypt	用於將明文資料通過KMS祕密金鑰加密為密文。重要您需要儲存體金鑰的通用唯一識別碼（KeyId）、密文（CiphertextBlob）、密碼編譯演算法（Algorithm）、初始向量（Iv）、填充模式（PaddingMode）和認證資料（Aad），然後使用Decrypt或AdvanceDecrypt解密。
Decrypt	將使用KMS祕密金鑰加密的密文解密為明文。
GenerateDataKey	用於產生資料密鑰，對資料按照KMS信封加密方式加密。
Sign	使用非對稱金鑰進行簽名。重要您可以通過Verify介面驗證簽名，也可擷取公開金鑰（GetPublicKey）到本地自行驗證簽名。
Verify	使用非對稱金鑰進行驗簽。
GetPublicKey	擷取指定非對稱金鑰的公開金鑰。

憑據介面

API	描述
GetSecretValue	擷取憑據值。

其他介面

API	描述
GenerateRandom	產生一個隨機數。