阿里云CLI(Alibaba Cloud Command Line Interface)是基于OpenAPI構建的通用命令行工具,您可以通過阿里云CLI實現自動化管理和維護密鑰管理服務。本文以調用ListKmsInstances
接口查詢KMS實例列表為例,為您介紹使用阿里云CLI調用密鑰管理服務的操作步驟。
前置概念
閱讀本文前,若您還不了解阿里云CLI,請參見什么是阿里云CLI。
安裝阿里云CLI
使用阿里云CLI前,您需要先安裝阿里云CLI。阿里云CLI為用戶提供了Windows、Linux和macOS三種操作系統下的安裝服務,請根據您使用設備的操作系統選擇對應的安裝服務。
Windows:在Windows上安裝阿里云CLI。
Linux:在Linux上安裝阿里云CLI。
macOS:在macOS上安裝阿里云CLI。
您也可使用阿里云提供的云命令行Cloud Shell調試阿里云CLI命令。關于云命令行的更多信息,請參見什么是云命令行。
配置阿里云CLI
使用阿里云CLI之前,您需要在阿里云CLI中配置身份憑證、地域ID等信息。阿里云CLI支持多種身份憑證,詳情請參見身份憑證類型。本文操作以AK類型憑證為例,具體操作步驟如下:
創建一個RAM用戶,并創建AccessKey,以便后續配置身份憑證使用。具體操作,請參見創建RAM用戶及創建AccessKey。
為RAM用戶授權。本文示例需授予RAM用戶只讀訪問密鑰管理服務的權限
AliyunKMSReadOnlyAccess
,授權操作請參見為RAM用戶授權。獲取可用的地域ID,以便后續配置身份憑證使用。阿里云CLI將使用您指定的地域發起API調用,密鑰管理服務的可用地域請參見服務接入地址。
說明使用阿里云CLI過程中您可使用
--region
選項指定地域發起命令調用,該選項在使用時將忽略默認身份憑證配置及環境變量設置中的地域信息。詳情請參見API命令可用選項。使用RAM用戶的AccessKey配置AK類型憑證,配置文件命名為
AkProfile
。具體操作,請參見配置示例。
生成CLI命令示例
單擊ListKmsInstances調試地址,訪問OpenAPI門戶。
在參數配置中輸入請求參數,單擊CLI示例頁簽,查看生成的CLI示例。
復制CLI示例或在云命令行中快速執行:
調用API
示例一:獲取阿里云CLI中支持調用的密鑰管理服務OpenAPI列表
以下代碼示例將為您展示如何使用--help
選項獲取支持阿里云CLI調用密鑰管理服務OpenAPI列表。您也可在API概覽中查看支持調用的API。
執行命令。
aliyun kms --help
輸出結果。
示例二:查詢KMS實例列表
以下代碼示例將為您展示如何使用阿里云CLI調用密鑰管理服務中的ListKmsInstances
命令,查詢KMS實例列表。
執行命令。
aliyun kms ListKmsInstances --region cn-hangzhou --PageNumber 1 --PageSize 10
輸出結果。
{ "KmsInstances": { "KmsInstance": [ { "KmsInstanceArn": "acs:kms:cn-hangzhou:141339776561****:keystore/kst-hzz66c5811c4c1wpv****", "KmsInstanceId": "kst-hzz66c5811c4c1wpv****" } ] }, "TotalCount": 1, "PageNumber": 1, "PageSize": 10, "RequestId": "8b640712-ab78-47ca-b648-55b665ee51bf" }
說明如果調用密鑰管理服務OpenAPI后返回錯誤,您需要根據返回的錯誤碼提示檢查傳入的請求參數及其取值是否正確。
您也可以記錄下調用返回的RequestID或SDK報錯信息,通過阿里云OpenAPI診斷平臺進行自助診斷。