应用平台 APPSTAGE-Python 语言项目通过原生SDK接入:使用SDK

时间：2023-11-24 18:31:51

应用平台 APPSTAGE

使用SDK

配置和初始化

在使用SDK的大多数其他能力前，首先需要对SDK进行初始化。在当前版本，SDK还未开放从本地缓存中初始化的能力，因此用户须保证应用程序可以正常连接至STS Server。目前有两种初始化SDK的方式：

通过配置文件初始化（推荐，支持更多自定义功能，配置修改不影响代码）。
通过参数值初始化（较快捷、更直接，适合快速开发、交互式场景）。

接口预览

pystssdk.sts_api.init(config_path=None, service=None, micro_service=None, sts_server_domain=None)

表1 接口描述参数说明
参数	说明
config_path (str)	配置文件路径，指定时，通过配置文件初始化。
service (str)	服务名称，通过参数值初始化时需指定。
micro_service (str)	微服务名称，通过参数值初始化时需指定。
sts_server_domain (str)	STS Server地址，通过参数值初始化时需指定。

初始化

通过配置文件初始化

通过这种方式初始化SDK，用户需要准备一份配置文件（注意与通过STS Agent申请的证书目录中的证书配置文件相区分），并在初始化时提供它的相对或绝对路径（config_path）。

配置文件是一份符合Python可解析标准的文件(.ini)，内容形如：

[sts]
server_domain=10.33.102.162:8080
config_path=/opt/huawei/certs/SecurityTokenService/SecurityTokenMicroService/SecurityTokenMicroService.ini
cache_folder=/opt/huawei/.cache

py-sts-sdk暂不支持自动定时刷新STS Token。

示例中第一行（即[sts]）为配置项所属的block，不可省略，也不可为其他值。

表2 配置参数含义
配置项	必选（M）/可选（O）	含义
server_domain	M	STS Server的地址及端口号，相当于Java SDK中的sts.server.domain。
config_path	M	STS证书自动签发工具生成的证书配置文件路径，可以是相对或绝对路径，相当于Java SDK中的sts.config.path。
cache_folder	O	STS Token缓存的路径，默认为用户home目录下.sts/，即~/.sts/，相当于Java SDK中的sts.cache.folder。

通过配置文件初始化的方式，可以最大化自定义SDK的表现。

通过参数值初始化
 通过这种方式初始化SDK，用户需要在初始化时提供服务名（service）、微服务名（micro_service）、STS服务器的地址（sts_server_domain），在这种情况下，SDK会遵循约定优于配置的模式，默认所需的证书配置文件位于/opt/huawei/certs/{service}/{micro_service}/{micro_service}.ini，其他设置均保持缺省状态下的默认值。