API 概覽 - Key Management Service

API標準及多語言預置SDK

本產品（Kms/2016-01-20）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。

在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。

自訂簽名情境

若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。

帳號與安全準備

阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。

服務管理

API	標題	API概述
DescribeAccountKmsStatus	查詢當前阿里雲帳號的Key Management Service狀態	查詢當前阿里雲帳號的Key Management Service狀態。
OpenKmsService	為當前阿里雲帳號開通Key Management Service	為當前阿里雲帳號開通Key Management Service。

執行個體管理

API	標題	API概述
ListKmsInstances	擷取執行個體列表	查詢 KMS 執行個體列表。
ConnectKmsInstance	串連執行個體並配置網路	啟用一個KMS執行個體。
GetKmsInstance	擷取執行個體	查詢一個KMS執行個體的詳情。
UpdateKmsInstanceBindVpc	更新執行個體分享VPC	更新KMS執行個體配置的VPC。
ReleaseKmsInstance	釋放KMS隨用隨付執行個體	釋放KMS隨用隨付執行個體。
GetDefaultKmsInstance	擷取預設KMS執行個體	擷取預設KMS執行個體。

金鑰管理

API	標題	API概述
CreateKey	建立一個主要金鑰	建立一個主要金鑰。
ListKeys	查詢調用者在調用地區的所有主要金鑰ID	查詢調用者在調用地區的所有主要金鑰ID。
DescribeKey	返回指定主要金鑰（CMK）的相關資訊	查詢使用者主要金鑰（CMK）詳情。
UpdateKeyDescription	更新主要金鑰描述資訊	更新主要金鑰的描述資訊。
EnableKey	啟用指定的主要金鑰進行加解密	啟用指定的主要金鑰進行加解密。
DisableKey	禁用指定的主要金鑰（CMK）進行加解密	禁用指定的主要金鑰（CMK）進行加解密。
GetPublicKey	擷取非對稱金鑰公開金鑰	擷取非對稱金鑰的公開金鑰。可以在本地使用公開金鑰進行加密、驗簽。
CreateAlias	給主要金鑰（CMK）建立一個別名	為主要金鑰（CMK）建立一個別名。
ListAliases	查詢目前使用者在當前地區的所有別名	查詢目前使用者在當前地區的所有別名。
ListAliasesByKeyId	查詢主要金鑰（CMK）所有別名	查詢與指定主要金鑰（CMK）對應的所有別名。
DeleteAlias	刪除別名	刪除別名。
UpdateAlias	更新主要金鑰（CMK）ID	更新已存在的別名所代表的主要金鑰（CMK）ID。
GetParametersForImport	擷取匯入主要金鑰（CMK）材料的參數	擷取匯入主要金鑰材料的參數。
ImportKeyMaterial	匯入密鑰材料	匯入密鑰材料。
DeleteKeyMaterial	刪除已匯入的密鑰材料	刪除已匯入的密鑰材料。
ScheduleKeyDeletion	申請刪除一個指定的主要金鑰（CMK)	申請刪除一個指定的主要金鑰（CMK)。
CancelKeyDeletion	撤銷密鑰刪除	撤銷密鑰刪除。
SetDeletionProtection	設定刪除保護。	為使用者主金鑰（CMK）開啟或關閉刪除保護。
UpdateRotationPolicy	更新密鑰輪轉策略	更新密鑰的周期性自動輪轉策略。
DescribeKeyVersion	查詢指定密鑰版本資訊	查詢指定密鑰版本資訊。
CreateKeyVersion	為主要金鑰建立一個新的密鑰版本	為使用者主要金鑰（CMK）建立密鑰版本。
ListKeyVersions	列出主要金鑰的所有密鑰版本	列出主要金鑰的所有密鑰版本。
SetKeyPolicy	設定密鑰策略	為KMS執行個體中的密鑰設定密鑰策略。
GetKeyPolicy	查詢密鑰策略	查詢指定密鑰的密鑰策略。

密碼運算

API	標題	API概述
GenerateDataKey	產生一個資料密鑰	產生一個隨機的資料密鑰，用於本機資料加密。
GenerateAndExportDataKey	產生一個資料密鑰並加密匯出	隨機產生一個資料密鑰，通過您指定的主要金鑰（CMK）和公開金鑰加密後，返回CMK加密資料密鑰的密文和公開金鑰加密資料密鑰的密文。
Encrypt	使用對稱主要金鑰加密明文	使用對稱金鑰將明文加密為密文。
Decrypt	解密密文	解密密文。
ReEncrypt	對密文進行轉加密	對密文進行轉加密。即先將密文解密，然後將解密得到的資料或者資料密鑰使用新的主要金鑰再次進行加密，返回加密結果。
ExportDataKey	使用傳入的公開金鑰加密匯出資料密鑰	使用傳入的公開金鑰加密匯出資料密鑰。
GenerateDataKeyWithoutPlaintext	產生一個資料密鑰，不需返回資料密鑰明文內容	產生一個隨機的資料密鑰。可以用資料密鑰進行本機資料的加密。
AsymmetricSign	使用非對稱金鑰進行簽名	使用非對稱金鑰進行簽名。
AsymmetricVerify	使用非對稱金鑰進行驗簽	使用非對稱金鑰進行驗簽。
AsymmetricEncrypt	使用非對稱金鑰進行加密	使用非對稱金鑰進行加密。
AsymmetricDecrypt	使用非對稱金鑰進行解密	使用非對稱金鑰進行解密。

憑證管理

API	標題	API概述
UpdateSecret	更新憑據的中繼資料	更新憑據的中繼資料。
UpdateSecretVersionStage	更新憑據的版本狀態	更新憑據的版本狀態。
UpdateSecretRotationPolicy	更新動態憑據的輪轉策略	更新憑據輪轉策略。
DescribeSecret	查詢憑據的中繼資料資訊	查詢憑據的中繼資料資訊。
ListSecretVersionIds	查詢憑據的所有版本資訊	查詢憑據的所有版本資訊。
GetRandomPassword	獲得一個隨機口令字串	獲得一個隨機口令字串。
PutSecretValue	為憑據存入一個新版本的憑據值	為通用憑據存入一個新版本的憑據值。
RestoreSecret	恢複被刪除的憑據	恢複被刪除的憑據。
RotateSecret	主動輪轉動態憑據	立即輪轉憑據。
SetSecretPolicy	設定憑據策略	為KMS執行個體中的憑據鑰設定憑據策略。
GetSecretPolicy	查詢憑據策略	查詢指定憑據的憑據策略。

標籤管理

API	標題	API概述
GetKmsInstanceQuotaInfos	擷取執行個體配額資訊	擷取執行個體配額資訊。
ListResourceTags	擷取使用者主要金鑰的標籤	擷取使用者主要金鑰的標籤。
TagResource	為主要金鑰或憑據設定標籤	為主要金鑰、憑據或認證綁定標籤。
UntagResource	刪除使用者主要金鑰或憑據的指定標籤	為主要金鑰、憑據或認證解除綁定標籤。

應用程式管理

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

其他

API	標題	API概述
CreateSecret	建立憑據	建立憑據並存入憑據的初始版本。
DeleteSecret	刪除憑據對象	刪除憑據對象。
DescribeRegions	查詢當前帳號的可用地區列表	查詢當前帳號的可用地區列表。
GetSecretValue	擷取憑據值	擷取憑據值。
ListSecrets	查詢目前使用者在當前地區建立的所有憑據	查詢目前使用者在當前地區建立的所有憑據。
ListTagResources	查詢標籤列表	查詢密鑰或憑據的標籤。
TagResources	綁定標籤	為密鑰或憑據綁定標籤。
UntagResources	解除綁定標籤	為密鑰或憑據解除綁定標籤。

Others

API	標題	API概述
GenerateMac	產生 HMAC 訊息驗證碼。	使用指定密鑰為訊息產生 HMAC 訊息認證碼。
VerifyMac	驗證 HMAC 訊息認證碼。	使用指定金鑰校驗特定訊息的 HMAC 訊息認證碼。