OBS客户端初始化
功能说明
OBS客户端(ObsClient)是访问OBS服务的Node.js客户端,它为调用者提供一系列与OBS服务进行交互的接口,用于管理、操作桶(Bucket)和对象(Object)等OBS服务上的资源。
方法定义
1.构造函数形式:ObsClient(parameter) 2.工厂方法形式:ObsClient.factory(parameter)
参数描述
字段名 |
类型 |
约束 |
说明 |
---|---|---|---|
access_key_id |
String |
可选 |
访问密钥中的AK。 |
secret_access_key |
String |
可选 |
访问密钥中的SK。 |
server |
String |
必选 |
连接OBS的服务地址。可包含协议类型、域名、端口号。示例:https://your-endpoint:443。 您可以从这里查看OBS当前开通的服务地址。 |
max_retry_count |
Number |
可选 |
HTTP/HTTPS连接异常时的请求重试次数。默认为3次。 |
https_agent |
Object |
可选 |
配置客户端网络https代理信息。 |
http_agent |
Object |
可选 |
配置客户端网络http代理信息。 |
timeout |
Number |
可选 |
HTTP/HTTPS请求超时时间(单位:秒)。默认为60秒。 |
ssl_verify |
Boolean 或 String |
可选 |
验证服务端证书参数。可能的取值:
默认为false。 |
long_conn_param |
Number |
可选 |
长连接模式参数(单位:秒)。当该参数大于等于0时,开启长连接模式,并将该参数作为TCP Keep-Alive数据包的初始延迟。 默认为空,代表关闭长连接模式。 |
is_cname |
Boolean |
可选 |
是否通过自定义域名访问OBS服务。默认为false。 |
代码样例
// 引入obs库 // 使用npm安装 var ObsClient = require('esdk-obs-nodejs'); var ProxyAgent = require('proxy-agent'); // 使用源码安装 // var ObsClient = require('./lib/obs'); // 创建ObsClient实例 var obsClient = new ObsClient({ //推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险。 //您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html access_key_id: process.env.ACCESS_KEY_ID, secret_access_key: process.env.SECRET_ACCESS_KEY, //这里以华北-北京四为例,其他地区请按实际情况填写 server: 'https://obs.cn-north-4.myhuaweicloud.com' max_retry_count : 1, timeout : 20, ssl_verify : false, long_conn_param : 0, http_agent : new ProxyAgent('*** Provide your Network proxy ***') // 配置网络代理 });