edit-icon download-icon

Options

Last Updated: Jan 11, 2018

OSS(options)

  • [accessKeyId] {String}: accessKeyId you create on Alibaba Cloud console website
  • [accessKeySecret] {String}: accessKeySecret you create
  • [bucket] {String}: the default bucket you want to access. If you do not have any bucket, use putBucket() to create one first.
  • [endpoint] {String}: oss region domain. It takes priority over region.
  • [region] {String}: the bucket data region location, see Data Regions. The default value is oss-cn-hangzhou.
  • [internal] {Boolean}: access OSS with Alibaba Cloud internal network or not. The default value is false. If your servers are running on Alibaba Cloud too, you can set it to true to reduce costs.
  • [secure] {Boolean}: instruct OSS client to use HTTPS (secure: true) or HTTP (secure: false) protocol.
  • [timeout] {String|Number}: instance level timeout for all operations. The default value is 60s.

Example:

  1. var oss = require('ali-oss');
  2. var store = oss({
  3. accessKeyId: 'your access key',
  4. accessKeySecret: 'your access secret',
  5. bucket: 'your bucket name',
  6. region: 'oss-cn-hangzhou'
  7. });
Thank you! We've received your feedback.