すべてのプロダクト
Search
ドキュメントセンター

Key Management Service:クライアントの初期化

最終更新日:Jan 20, 2025

このトピックでは、KMSインスタンスSDKを使用してKMSインスタンスAPIリクエストを送信する前にクライアントを初期化する手順について説明します。

SDK の初期化

  1. クライアントインスタンスを初期化します。

    # -*- coding: utf-8 -*-
    from openapi.models import Config
    from sdk.client import Client
    
    config = Config()
    # The connection protocol. Set the value to https. The KMS instance service only allows access through the HTTPS protocol.
    config.protocol = "https"
    
    # Client Key.
    config.client_key_file = "<CLIENT_KEY_FILE>"
    
    # Client Key decryption password.
    config.password = os.getenv('CLIENT_KEY_PASSWORD')
    
    # The endpoint of your KMS instance. Set the value in the following format: <ID of your KMS instance>.cryptoservice.kms.aliyuncs.com.
    config.endpoint = "<ENDPOINT>"
    client = Client(config)
  2. ランタイムパラメーター (RuntimeOptions) を設定して、KMSインスタンスのCA証明書を設定します。

    重要

    SSL/TLS証明書の信頼性を検証するため、本番環境での安全な通信を確保するためにインスタンスCA証明書を設定することが重要です。 この機能を有効にしておくことをお勧めします。 ただし、オフラインテスト環境などでSSL/TLS証明書の検証をバイパスする必要がある場合は、RuntimeOptionsignore_sslフィールドをtrueに設定できます。

    KMSインスタンスのCA証明書パスを設定するには、RuntimeOptionsverifyフィールドにパスを割り当てます。 以下は例です。

    # -*- coding: utf-8 -*-
    from openapi_util.models import RuntimeOptions
    
    runtime_options = RuntimeOptions()
    # CA certificate path
    runtime_options.verify = "<CA_CERTIFICATE_FILE_PATH>"
    

変数の説明

エンドポイント

エンドポイントは、KMSインスタンスのドメイン名アドレスです。

  1. インスタンス管理 ページに移動し、ソフトウェアキー管理 または ハードウェアキー管理 タブをクリックし、目的のKMSインスタンスを選択します。

  2. インスタンスIDをクリックして製品ページに移動し、インスタンス VPC エンドポイントを見つけます。image

client_key_ファイル

ClientKeyFilePathは、アプリケーションのID資格情報が保存される場所です。 ClientKeyが作成されると、通常はclientKey_****.jsonのようなデフォルトのファイル名で、ブラウザによって自動的にダウンロードされます。

パスワード

パスワードは、ClientKeyのセキュリティトークンです。 ClientKeyと同様に、作成時にブラウザによって自動的にダウンロードされます。デフォルトのファイル名はclientKey_****_Password.txtです。

verify

CA証明書はKMSインスタンスに関連付けられています。

  1. インスタンス管理 ページで、インスタンスCA証明書 セクションを見つけ、ダウンロード をクリックします。

  2. インスタンスCA証明書 ダイアログボックスで、インスタンスIDを選択し、ダウンロード をクリックして安全に保存します。

    ダウンロードしたCA証明書のデフォルトのファイル名はPrivateKmsCA_kst-******.pemです。image