initialize接口

接口功能

初始化MindIO ACP Client。

  • 若不使用TLS认证特性，可以不调用此接口，直接使用load/save相关接口访问MindIO ACP服务。
  • 若使用TLS认证特性，则必须在调用其它MindIO ACP接口之前调用此初始化接口，创建TLS连接。

接口格式

torch_mindio.initialize(tls_open: bool = True, tls_path: Dict[str, str] = None) -> int

接口参数

参数

是否必选

说明

取值要求

tls_open

可选

是否开启TLS认证的开关，默认值为True。
  • False：不开启TLS认证。
  • True：开启TLS认证。

tls_path

可选

开启TLS认证时，传入证书或秘钥的路径集合。参数详情请参见表1。

有效路径集合。
表1 参数tls_path说明

key

value

是否必选

说明

取值要求

'cert_path'

cert_path

可选

开启TLS认证时，Client端证书保存路径。不开启TLS认证时，忽略此参数。

有效的证书文件路径。

'ca_path'

ca_path

可选

开启TLS认证时，Client端用于验证Server端证书的CA保存路径。不开启TLS认证时，忽略此参数。

有效的CA文件路径。

'pri_key_path'

pri_key_path

可选

开启TLS认证时，Client端私钥保存路径。不开启TLS认证时，忽略此参数。

有效的私钥文件路径。

'key_pass_path'

key_pass_path

可选

开启TLS认证时，Client端密钥文件的口令文件，里面保存的是加密后的口令。不开启TLS认证时，忽略此参数。

有效的口令文件路径。

'pmt_path'

pmt_path

可选

开启TLS认证时，Client端密码仓路径。不开启TLS认证时，忽略此参数。

有效的密码仓路径。

'crl_path'

crl_path

可选

开启TLS认证时，Client端证书吊销列表文件路径。不开启TLS认证时，忽略此参数。

有效的吊销证书列表文件路径。

使用样例1

>>> # Initialize without TLS
>>> torch_mindio.initialize(tls_open=False)

使用样例2

>>> # Initialize with TLS
>>> tls_path = {
    'cert_path': '/home/certs/client.pem',
    'ca_path': '/home/certs/ca.crt',
    'pri_key_path': '/home/keys/client_key.pem',
    'pmt_path': '/home/sec_dir/tools/pmt',
    'key_pass_path': '{user.homedir}/crypt_repo/password.txt',
    'crl_path': '/home/certs/crl.crl'
    }
>>> torch_mindio.initialize(tls_open=True, tls_path=tls_path)

返回值

父主题： Torch