本文列出了KMS提供的API接口列表及相關描述。
服務管理
API | 描述 |
查詢當前阿里云賬號的可用地域列表。 | |
為當前阿里云賬號開通密鑰管理服務。 | |
查詢當前阿里云賬號的密鑰管理服務狀態。 |
實例管理
API | 描述 |
啟用一個KMS實例。 | |
查詢一個KMS實例的詳情。 | |
查詢KMS實例列表。 | |
更新KMS實例配置的VPC。 |
密鑰管理
密鑰管理接口用于密鑰、別名的創建、刪除等管理操作。
API | 描述 |
創建密鑰。用戶可以選擇由KMS生成密鑰材料，也可以選擇自己上傳密鑰材料（即BYOK方式）。 | |
用于在創建外部密鑰（BYOK）時，獲取將密鑰材料導入密鑰時所需的參數。 | |
用于在創建外部密鑰（BYOK）時，將密鑰材料導入密鑰。 | |
修改密鑰的狀態為啟用。 | |
修改密鑰的狀態為禁用。 | |
查詢指定密鑰的信息。 | |
查詢阿里云賬號在調用地域的所有密鑰。 | |
更新密鑰的描述信息。 | |
創建一個別名，并且將別名與一個密鑰綁定。 | |
更新已存在的別名所代表的密鑰ID。 | |
刪除別名。 | |
查詢阿里云賬號在調用地域的所有別名。 | |
查詢與指定密鑰綁定的別名。 | |
為密鑰開啟或關閉刪除保護。 | |
計劃刪除密鑰。將密鑰的狀態設置為待刪除狀態，處于待刪除狀態的密鑰，會在計劃日期到期后刪除。 | |
取消計劃刪除。處于待刪除狀態的密鑰，在計劃的日期到期之前，可以取消刪除的計劃，重新設置密鑰狀態為啟用。 | |
刪除密鑰材料。 重要 僅支持刪除默認密鑰（主密鑰）中的外部密鑰材料。 | |
為密鑰創建新的密鑰版本。僅軟件密鑰管理實例中的對稱密鑰支持。 說明 如果您的密鑰不是在KMS實例中創建的密鑰，則該操作僅非對稱密鑰支持。 | |
查詢指定密鑰版本信息。 | |
查詢密鑰的所有密鑰版本。 | |
更新密鑰的輪轉策略。如果配置密鑰自動輪轉，KMS將周期性自動生成新的密鑰版本。 |
密碼運算
密碼運算接口用于對數據進行密碼運算，例如使用KMS中的密鑰對數據進行加密、生成數據密鑰、解密、計算數字簽名。
使用KMS密鑰管理實例中的密鑰進行密碼運算，請使用KMS實例API。具體信息，請參見KMS實例API概覽。
憑據管理
憑據管理
KMS提供憑據的托管、保護、分發和輪轉能力。
API
描述
創建憑據，并存入憑據的初始版本。
查詢當前阿里云賬號在調用地域的所有憑據。
獲取憑據的元數據信息。
更新憑據的元數據。
為憑據存入一個新版本的憑據值。
說明僅通用憑據支持。
更新憑據的版本狀態。
說明僅通用憑據支持。
計劃刪除或直接刪除憑據。
恢復計劃刪除中的憑據。
查詢憑據的所有版本信息。
獲得一個隨機密碼串。
手動輪轉憑據。
更新憑據輪轉策略。
獲取憑據值
GetSecretValue：獲取憑據值。
重要KMS實例API中也提供獲取憑據值接口（GetSecretValue），具體調用的哪個API依賴于您使用的SDK。關于如何選擇SDK，請參見SDK使用指引。
標簽管理
您可以為密鑰或憑據添加多個標簽，每一個標簽為一組標簽鍵（TagKey）和標簽值（TagValue）。
TagResource、UntagResource、ListResourceTags僅支持對單個資源進行操作，TagResources、UntagResources、ListTagResources支持對多個資源進行批操作。
API | 描述 |
為單個密鑰或者單個憑據綁定標簽。 | |
刪除單個密鑰或者單個憑據的指定標簽。 | |
查詢單個密鑰的所有標簽。 | |
批量為密鑰或憑據綁定標簽。 | |
批量刪除密鑰或者憑據的指定標簽。 | |
批量查詢密鑰或憑據的所有標簽或指定標簽。 |
應用管理
API | 描述 |
創建一條網絡控制規則，設置允許訪問KMS的私網IP或私網網段。 | |
刪除一條網絡控制規則。 | |
查詢一個網絡控制規則的詳情。 | |
查詢網絡控制規則列表。 | |
更新一個網絡控制規則。 | |
創建一個權限策略，設置允許應用訪問的密鑰和憑據。 | |
刪除一個權限策略。 | |
查詢一個權限策略的詳情。 | |
更新一個權限策略。 | |
查詢權限策略列表。 | |
創建一個應用接入點。 | |
刪除一個應用接入點。 | |
查詢一個應用接入點的詳情。 | |
查詢應用接入點列表。 | |
更新一個應用接入點信息。 | |
創建一個應用身份憑證（ClientKey）。 | |
刪除一個應用身份憑證（ClientKey）。 | |
查詢應用身份憑證（ClientKey）列表。 | |
獲取一個應用身份憑證（ClientKey）信息。 |