全部產品
Search
文件中心

Key Management Service:初始化用戶端

更新時間:Dec 27, 2024

使用KMS執行個體SDK發起KMS執行個體API請求前,您需要初始化用戶端。本文介紹如何初始化用戶端。

初始化SDK

  1. 初始化Client執行個體。

    # -*- coding: utf-8 -*-
    from openapi.models import Config
    from sdk.client import Client
    
    config = Config()
    # 連線協定請設定為"https"。KMS執行個體服務僅允許通過HTTPS協議訪問。
    config.protocol = "https"
    
    # Client Key。
    config.client_key_file = "<your-client-key-file>"
    
    # Client Key解密口令。
    config.password = os.getenv('CLIENT_KEY_PASSWORD')
    
    # 設定endpoint為<your KMS Instance Id>.cryptoservice.kms.aliyuncs.com。
    config.endpoint = "<your-endpoint>"
    client = Client(config)
  2. 通過配置運行時參數(RuntimeOptions)設定KMS執行個體的CA認證。

    重要

    設定執行個體CA認證是為保障生產環境通訊安全,其重要作用在於驗證SSL/TLS認證的有效性,建議您始終保持此功能開啟。如您確有需要關閉驗證SSL/TLS認證,例如線下測試情境,可通過將運行時參數RuntimeOptionsignore_ssl欄位設定為true實現。

    設定RuntimeOptionsverify欄位為KMS執行個體CA憑證路徑。程式碼範例如下:

    # -*- coding: utf-8 -*-
    from openapi_util.models import RuntimeOptions
    
    runtime_options = RuntimeOptions()
    # ca憑證路徑
    runtime_options.verify = "<your-ca-certificate-file-path>"
    

變數說明

endpoint

即KMS執行個體網域名稱地址。

  1. 实例管理頁面,單擊软件密钥管理硬件密钥管理頁簽後,選擇目標KMS執行個體。

  2. 單擊執行個體ID進入到詳情頁,查看实例VPC地址image

client_key_file

即應用身份憑證的路徑。建立ClientKey後瀏覽器會自動下載,檔案名稱預設為clientKey_****.json

password

即ClientKey的口令。建立ClientKey後瀏覽器會自動下載,檔案名稱預設為clientKey_****_Password.txt

verify

KMS執行個體CA認證。

  1. 实例管理頁面,單擊获取实例CA证书地區的下载

  2. 获取实例CA证书對話方塊中選擇執行個體ID,單擊下载並妥善保管。

    CA認證下載後檔案名稱預設為PrivateKmsCA_kst-******.pem。image