更新时间:2024-11-13 GMT+08:00

配置OBS客户端(Node.js SDK)

开发过程中,您有任何问题可以在github上提交issue

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

参数

描述

建议值

access_key_id

访问密钥中的AK。

N/A

secret_access_key

访问密钥中的SK。

N/A

server

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

N/A

max_retry_count

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

[1,5]

timeout

HTTP/HTTPS请求超时时间(单位:秒)。默认为60秒。

[10, 60]

http_agent

配置使用http代理,可选项。默认不配置

N/A

https_agent

配置使用https代理,可选项。默认不配置

N/A

ssl_verify

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

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

默认为false。

N/A

long_conn_param

长连接模式参数(单位:秒)。当该参数大于等于0时,开启长连接模式,并将该参数作为TCP Keep-Alive数据包的初始延迟

默认为空,代表关闭长连接模式。

N/A

is_cname

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

N/A

  • 建议值为N/A的表示需要根据实际情况进行设置。
  • 如网络状况不佳,建议增大timeout的值。
  • 如果设置的server不带协议类型,则默认使用HTTPS协议。
  • 如果启用了长连接模式,使用完OBS客户端后必须调用ObsClient.close方法显式关闭,回收连接资源。
  • 出于DNS解析性能和OBS服务可靠性的考虑,不允许将server设置为IP,必须使用域名访问OBS服务。
  • 配置SDK代理请参见配置SDK代理(Node.js SDK)