API概覽 - Key Management Service

本文列出了KMS提供的API介面列表及相關描述。

服務管理

API	描述
DescribeRegions	查詢當前阿里雲帳號的可用地區列表。
OpenKmsService	為當前阿里雲帳號開通Key Management Service。
DescribeAccountKmsStatus	查詢當前阿里雲帳號的Key Management Service狀態。

執行個體管理

API	描述
ConnectKmsInstance	啟用一個KMS執行個體。
GetKmsInstance	查詢一個KMS執行個體的詳情。
ListKmsInstances	查詢KMS執行個體列表。
UpdateKmsInstanceBindVpc	更新KMS執行個體配置的VPC。

密鑰管理

密鑰管理介面用於密鑰、別名的建立、刪除等管理操作。

API	描述
CreateKey	建立密鑰。使用者可以選擇由KMS產生密鑰材料，也可以選擇自己上傳密鑰材料（即BYOK方式）。
GetParametersForImport	用於在建立外部金鑰（BYOK）時，擷取將密鑰材料匯入密鑰時所需的參數。
ImportKeyMaterial	用於在建立外部金鑰（BYOK）時，將密鑰材料匯入密鑰。
EnableKey	修改密鑰的狀態為啟用。
DisableKey	修改密鑰的狀態為禁用。
DescribeKey	查詢指定密鑰的資訊。
ListKeys	查詢阿里雲帳號在調用地區的所有密鑰。
UpdateKeyDescription	更新密鑰的描述資訊。
CreateAlias	建立一個別名，並且將別名與一個密鑰綁定。
UpdateAlias	更新已存在的別名所代表的密鑰ID。
DeleteAlias	刪除別名。
ListAliases	查詢阿里雲帳號在調用地區的所有別名。
ListAliasesByKeyId	查詢與指定密鑰綁定的別名。
SetDeletionProtection	為密鑰開啟或關閉刪除保護。
ScheduleKeyDeletion	計劃刪除密鑰。將密鑰的狀態設定為待刪除狀態，處於待刪除狀態的密鑰，會在計劃日期到期後刪除。
CancelKeyDeletion	取消計劃刪除。處於待刪除狀態的密鑰，在計劃的日期到期之前，可以取消刪除的計劃，重新設定密鑰狀態為啟用。
DeleteKeyMaterial	刪除密鑰材料。重要僅支援刪除預設密鑰（主要金鑰）中的外部金鑰材料。
CreateKeyVersion	為密鑰建立新的密鑰版本。僅軟體密鑰管理執行個體中的對稱金鑰支援。說明如果您的密鑰不是在KMS執行個體中建立的密鑰，則該操作僅非對稱金鑰支援。
DescribeKeyVersion	查詢指定密鑰版本資訊。
ListKeyVersions	查詢密鑰的所有密鑰版本。
UpdateRotationPolicy	更新密鑰的輪轉策略。如果配置密鑰自動輪轉，KMS將周期性自動產生新的密鑰版本。

密碼運算

密碼運算介面用於對資料進行密碼運算，例如使用KMS中的金鑰組資料進行加密、產生資料密鑰、解密、計算數位簽章。

重要

使用KMS密鑰管理執行個體中的密鑰進行密碼運算，請使用KMS執行個體API。具體資訊，請參見KMS執行個體API概覽。

憑據管理

憑據管理

KMS提供憑據的託管、保護、分發和輪轉能力。

API	描述
CreateSecret	建立憑據，並存入憑據的初始版本。
ListSecrets	查詢當前阿里雲帳號在調用地區的所有憑據。
DescribeSecret	擷取憑據的中繼資料資訊。
UpdateSecret	更新憑據的中繼資料。
PutSecretValue	為憑據存入一個新版本的憑據值。說明僅通用憑據支援。
UpdateSecretVersionStage	更新憑據的版本狀態。說明僅通用憑據支援。
DeleteSecret	計劃刪除或直接刪除憑據。
RestoreSecret	恢複計劃刪除中的憑據。
ListSecretVersionIds	查詢憑據的所有版本資訊。
GetRandomPassword	獲得一個隨機密碼串。
RotateSecret	手動輪轉憑據。
UpdateSecretRotationPolicy	更新憑據輪轉策略。

擷取憑據值
GetSecretValue：擷取憑據值。
重要
KMS執行個體API中也提供擷取憑據值介面（GetSecretValue），具體調用的哪個API依賴於您使用的SDK。關於如何選擇SDK，請參見SDK參考。

標籤管理

您可以為密鑰或憑據添加多個標籤，每一個標籤為一組標籤鍵（TagKey）和標籤值（TagValue）。

說明

TagResource、UntagResource、ListResourceTags僅支援對單個資源進行操作，TagResources、UntagResources、ListTagResources支援對多個資源進行批操作。

API	描述
TagResource	為單個密鑰或者單個憑據綁定標籤。
UntagResource	刪除單個密鑰或者單個憑據的指定標籤。
ListResourceTags	查詢單個密鑰的所有標籤。
TagResources	批量為密鑰或憑據綁定標籤。
UntagResources	大量刪除密鑰或者憑據的指定標籤。
ListTagResources	批量查詢密鑰或憑據的所有標籤或指定標籤。

應用管理

API	描述
CreateNetworkRule	建立一條網路控制規則，設定允許訪問KMS的私網IP或私網網段。
DeleteNetworkRule	刪除一條網路控制規則。
DescribeNetworkRule	查詢一個網路控制規則的詳情。
ListNetworkRules	查詢網路控制規則列表。
UpdateNetworkRule	更新一個網路控制規則。
CreatePolicy	建立一個權限原則，設定允許應用訪問的密鑰和憑據。
DeletePolicy	刪除一個權限原則。
DescribePolicy	查詢一個權限原則的詳情。
UpdatePolicy	更新一個權限原則。
ListPolicies	查詢權限原則列表。
CreateApplicationAccessPoint	建立一個應用存取點。
DeleteApplicationAccessPoint	刪除一個應用存取點。
DescribeApplicationAccessPoint	查詢一個應用存取點的詳情。
ListApplicationAccessPoints	查詢應用存取點列表。
UpdateApplicationAccessPoint	更新一個應用存取點資訊。
CreateClientKey	建立一個應用身份憑證（ClientKey）。
DeleteClientKey	刪除一個應用身份憑證（ClientKey）。
ListClientKeys	查詢應用身份憑證（ClientKey）列表。
GetClientKey	擷取一個應用身份憑證（ClientKey）資訊。