使用阿里雲CLI調用Key Management Service - Key Management Service

阿里雲CLI（Alibaba Cloud Command Line Interface）是基於OpenAPI構建的通用命令列工具，您可以通過阿里雲CLI實現自動化管理和維護Key Management Service。本文以調用ListKmsInstances介面查詢KMS執行個體列表為例，為您介紹使用阿里雲CLI調用Key Management Service的操作步驟。

前置概念

閱讀本文前，若您還不瞭解阿里雲CLI，請參見什麼是阿里雲CLI。

安裝阿里雲CLI

使用阿里雲CLI前，您需要先安裝阿里雲CLI。阿里雲CLI為使用者提供了Windows、Linux和macOS三種作業系統下的安裝服務，請根據您使用裝置的作業系統選擇對應的安裝服務。

您也可使用阿里雲提供的雲命令列Cloud Shell調試阿里雲CLI命令。關於雲命令列的更多資訊，請參見什麼是雲命令列。

配置阿里雲CLI

重要

阿里雲主帳號擁有所有產品OpenAPI的管理和存取權限，風險很高。強烈建議您建立RAM身份，並依據最小化許可權原則授予許可權，使用RAM身份訪問OpenAPI。Key Management Service支援的權限原則，請參見自訂權限原則。

使用阿里雲CLI之前，您需要在阿里雲CLI中配置身份憑證、地區ID等資訊。阿里雲CLI支援多種身份憑證，詳情請參見身份憑證類型。本文操作以AK類型憑證為例，具體操作步驟如下：

建立一個RAM使用者，並建立AccessKey，以便後續配置身份憑證使用。具體操作，請參見建立AccessKey。
為RAM使用者授權。本文樣本需授予RAM使用者唯讀訪問Key Management Service的許可權AliyunKMSReadOnlyAccess，授權操作請參見為RAM使用者授權。
擷取可用的地區ID，以便後續配置身份憑證使用。阿里雲CLI將使用您指定的地區發起API調用，Key Management Service的可用地區請參見服務接入地址。
說明
使用阿里雲CLI過程中您可使用--region選項指定地區發起命令調用，該選項在使用時將忽略預設身份憑證配置及環境變數設定中的地區資訊。詳情請參見API命令可用選項。
使用RAM使用者的AccessKey配置AK類型憑證，設定檔命名為AkProfile。具體操作，請參見配置樣本。

產生CLI命令樣本

單擊ListKmsInstances調試地址，訪問OpenAPI門戶。
在參數配置中輸入請求參數，單擊CLI樣本頁簽，查看產生的CLI樣本。
複製CLI樣本或在雲命令列中快速執行：
- 單擊運行命令按鈕，可喚出雲命令列並快速完成命令調試。
- 單擊複製按鈕，將CLI樣本複製到剪貼簿中，可粘貼至本地Shell工具中運行。
  說明
  - 複製CLI樣本到本地Shell工具中進行調試時請注意參數格式。關於阿里雲CLI命令參數使用格式的詳細資料，請參見參數格式說明。
  - OpenAPI門戶產生樣本中會預設添加--region選項，複製命令到本地調用時阿里雲CLI將忽略預設身份憑證配置及環境變數設定中的地區資訊，優先使用指定的地區調用命令，您可根據需要對該選項進行刪除或保留。

調用API

樣本一：擷取阿里雲CLI中支援調用的Key Management ServiceOpenAPI列表

以下程式碼範例將為您展示如何使用--help選項擷取支援阿里雲CLI調用Key Management ServiceOpenAPI列表。您也可在API概覽中查看支援調用的API。

執行命令。
```
aliyun kms --help
```
輸出結果。

樣本二：查詢KMS執行個體列表

以下程式碼範例將為您展示如何使用阿里雲CLI調用Key Management Service中的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"
}

說明

如果調用Key Management ServiceOpenAPI後返回錯誤，您需要根據返回的錯誤碼提示檢查傳入的請求參數及其取值是否正確。

您也可以記錄下調用返回的RequestID或SDK報錯資訊，通過阿里雲OpenAPI診斷平台進行自助診斷。