全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

初始化(Node.js)

最近更新时间:2025-03-31 11:23:46

使用密钥初始化

var KS3 = require('ks3');
//方式一 使用Endpoint时可使用下面的形式创建【推荐】
 var client = new KS3({
     AK: '<ak>', // 访问的AccessKeyID
     SK: '<sk>', // 访问的SecretAccessKey
     BucketName: '<bucketName>',
     Endpoint: '<endpoint>'
})

//方式二 使用region创建
var client = new KS3('<AK>','<SK>','<BucketName>', '<Region>');
//不填写aksk默认使用匿名访问

以下为配置项参数详细说明:

参数名

参数描述

是否必填

AK

金山云提供的AccessKeyID。默认值:无。

SK

金山云提供的SecretAccessKey。默认值:无。

Region

存储空间所在的区域。默认值:BEIJING。

Endpoint

金山云提供的各个Region的域名(例 ks3-cn-beijing.ksyuncs.com),示例值:ks3-cn-beijing.ksyuncs.com,详情可参考文档:Endpoint与Region的对应关系。也可以是用户自定义域名,如果是用户自定义域名,需要将domainMode设置为true,非必填

BucketName

存储空间的名称,非必填,也可在调用具体api时指定。默认值:无。

DomainMode

使用自定义域名。默认值:false。

可选值:

  • true:使用自定义域名,此时Endpoint参数需填写自定义域名。

  • false:不使用自定义域名。

Internal

是否内网访问。默认值:false。具体定义可参考:内网域名参考文档。

可选值:

  • true:内网访问。

  • false:外网访问。

Timeout

超时时间。默认值为 180000 ,单位为毫秒。

Secure

是否使用https。默认值:true。

可选值:

  • true:使用https访问。

  • false:使用http访问。

ProxyUrl

代理 URL,默认为空,格式:http(s)://<hostname>:<port>。

使用示例:http(s)://example.com:3128;http://127.0.0.1:8080

ProxyAuth

代理身份认证信息,默认为空。

使用示例:

{

user: '', // 代理认证的用户名,默认为空

pass: '' // 代理认证的密码,默认为空

}

MaxRetryTimes

出错重试次数,默认值:3。即请求失败后重试3次,总共请求4次。

RetryStrategy

重试等待策略。默认值:'ExponentialWait'(指数等待策略)。详情可参考文档:初始化配置实践

可选值:

  • ExponentialWait:指数等待策略。

  • FixedWait:固定等待策略。

  • LinearWait:线性等待策略。

  • JitterWait:抖动等待策略。

DnsCache

是否开启dns缓存。默认值:true。

可选值:

  • true:开启dns缓存。

  • false:不开启dns缓存。

DnsCacheTimeout

DNS缓存清理时间。默认值:30s。

• 如果您之前已经实现了自定义的重试机制,请确保 maxRetryTimes 参数与您的实现不会导致多次重试。例如,若您的代码已经重试了 2 次,而 maxRetryTimes 设置为 3,则实际重试次数可能会达到 6 次(2 × 3)。

• 为避免冲突,建议您检查现有代码,并根据需要调整重试逻辑或禁用 maxRetryTimes 参数(将其设置为 0)。

纯净模式常规模式

纯净模式

点击可全屏预览文档内容