本文介绍初始化时涉及的配置项以及配置示例。

配置项

OSS(options)中的各个配置项说明请参见下表。

配置项 类型 说明
accessKeyId String 阿里云账号、RAM用户或者临时访问凭证STS的AccessKey ID。
accessKeySecret String 阿里云账号、RAM用户或者临时访问凭证STS的AccessKey Secret。
stsToken String 从STS服务获取的安全令牌(SecurityToken)。更多信息,请参见使用STS进行临时授权
bucket String 填写Bucket名称,该Bucket通过控制台或PutBucket接口创建。
endpoint String 支持外网域名、内网域名、自定义域名、传输加速域名等。关于访问域名的更多信息,请参见访问域名和数据中心
注意 当您通过自定义域名或者传输加速域名访问OSS时,需指定endpoint配置项,无需额外配置region。关于指定endpoint配置项的示例,请参见绑定自定义域名
region String 填写Bucket所在地域, 默认值为oss-cn-hangzhou。
注意 当您通过外网域名或者内网域名访问OSS时,需指定region配置项,无需额外配置endpoint。关于指定region配置项的示例,请参见简单上传
internal Boolean 是否使用阿里云内网访问,默认值为false。例如通过ECS访问OSS,则设置internal为true,采用internal的endpoint可节省费用。
cname Boolean 是否支持自定义域名,默认值为false。如果设置cname为true,则endpoint传入自定义域名时,自定义域名需要先和Bucket绑定。
isRequestPay Boolean Bucket是否开启请求者付费模式,默认值为false。更多信息,请参见请求者付费模式
secure Boolean OSS访问协议。如果您需要通过HTTPS访问OSS,则secure设置为true。如果您需要通过HTTP访问OSS,则secure设置为false。更多信息,请参见常见问题
timeout String|Number 超时时间,默认值为60000,单位为毫秒。

配置示例

Browser..js初始化配置示例如下:

// 假设浏览器环境中已经引入OSS对象,可以通过`script`或者`npm`方式引入。
let store = new OSS({
  // 从STS服务获取的临时访问密钥(AccessKey ID和AccessKey Secret)。
  accessKeyId: 'yourAccessKeyId',
  accessKeySecret: 'yourAccessKeySecret',
  // 从STS服务获取的安全令牌(SecurityToken)。
  stsToken: 'yourSecurityToken',
  // 填写Bucket名称。
  bucket: 'your bucket name',
  // 填写Bucket所在地域。以华东1(杭州)为例,yourRegion填写为oss-cn-hangzhou。
  region: 'oss-cn-hangzhou'
});