更新时间:2023-01-19 GMT+08:00

配置OBS客户端

开发过程中,您有任何问题可以在github上提交issue接口参考文档详细介绍了每个接口的参数和使用方法。

您可通过初始化参数对ObsClient进行配置,可以配置的参数见下表:

参数

描述

建议值

key

访问密钥中的AK。

N/A

secret

访问密钥中的SK。

N/A

endpoint

连接OBS的服务地址。包含协议类型、域名(或IP)、端口号。示例:https://your-endpoint:443。(出于安全性考虑,建议使用https协议)

N/A

ssl_verify

验证服务端证书参数。可能的取值:

  • 服务端pem格式根证书文件路径;
  • true:使用默认的CAs验证服务端证书;
  • false:表示不验证服务端证书。

默认为false。

N/A

max_retry_count

HTTP/HTTPS连接异常时的请求重试次数。默认为3次。

[1,5]

socket_timeout

Socket层传输数据的超时时间(单位:秒)。默认为60秒。

[10, 60]

connect_timeout

建立HTTP/HTTPS连接的超时时间(单位:秒)。默认为60秒。

[10, 60]

chunk_size

读socket流时的块大小(单位:字节)。默认为65536字节。

默认

is_cname

是否通过自定义域名访问OBS服务。默认为false。

N/A

  • 建议值为N/A的表示需要根据实际情况进行设置。
  • 如网络状况不佳,建议增大socket_timeout和connect_timeout的值。
  • 如果设置的endpoint不带协议类型,则默认使用HTTPS协议。
  • 使用完OBS客户端后可以调用ObsClient -> close方法显式关闭,回收连接资源。
  • 如果未调用ObsClient -> close方法,则该方法会被ObsClient的析构函数调用,以确保连接资源的释放。
  • 出于DNS解析性能和OBS服务可靠性的考虑,不允许将endpoint设置为IP,必须使用域名访问OBS服务。