初始化客户端

更新时间:2025-03-20 01:45:53

使用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. 实例管理页面,单击软件密钥管理硬件密钥管理页签后,选择目标KMS实例。

  2. 单击实例ID或单击操作列详情,在详情页,实例CA证书区域单击下载并妥善保管。

    CA证书下载后文件名默认为PrivateKmsCA_kst-******.pem。image

  • 本页导读 (1)
  • 初始化SDK
  • 变量说明
  • endpoint
  • client_key_file
  • password
  • verify
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等