初始化

最近更新时间:2023-01-03 15:29:09

查看PDF

创建对象并传入配置项

import KS3 from 'ks3-js-sdk';

let config = {
    AK: '<ak>',
    SK: '<sk>',
    region: '<region>',
    bucket: '<bucket>'
}

let ks3 = new KS3(config);

config配置参数

名称 描述 是否必选
AK 您的AccessKeyID或者临时访问凭证STS的AccessKeyID
SK 您的SecretAccessKey或者临时访问凭证STS的SecretAccessKey
region 存储空间所在的区域,示例: BEIJING
domain 是否用户自定义域名,默认为false
bucket 存储空间的名称,也可在调用具体api时指定
protocol 自定义的请求协议,可选项 https:http:,默认判断当前页面是 http: 时使用 http:,否则使用 https:
forceHostStyle 是否使用三级域名,默认值为true
chunkSize 分块上传的最小单位,默认值为5 * 1024 * 1024,单位为Byte
retryTimes 分块上传重试次数,默认值为2
parallelLimit 分块上传并发个数,默认值为10
progressInterval 回调时间间隔,默认值为1000,单位为毫秒
timeout 超时时长,默认值为0,表示不设置超时时间,单位为毫秒
securityToken 从STS服务获取的临时身份凭证(SecurityToken)

说明

  • 如果您使用的bucket所属region是KS3提供,需要将domain设置为false。如果是用户自定义域名,需要将domain设置为true。

  • 由于固定密钥放在前端会有安全风险,正式部署时我们推荐使用临时密钥的方式。实现过程为:前端首先请求服务端,服务端使用固定密钥调用 STS 服务申请临时密钥,然后返回临时密钥到前端使用。详情请参见 临时密钥生成文档。同时ks3 js sdk为您提供获取临时密钥示例,示例参见js sdk 内 example/server。

文档内容是否对您有帮助?

根本没帮助
文档较差
文档一般
文档不错
文档很好

在文档使用中是否遇到以下问题

内容不全,不深入
内容更新不及时
描述不清晰,比较混乱
系统或功能太复杂,缺乏足够的引导
内容冗长

更多建议

0/200

评价建议不能为空

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

问题反馈