Object Storage Service：初始化（Browser.js SDK）

accessKeyId {String}：在阿里雲控制台網站上建立的存取金鑰。

accessKeySecret {String}：在阿里雲控制台建立的存取金鑰秘密。

[stsToken] {String}：用於臨時授權。

[refreshSTSToken] {Function}：當STS資訊到期時自動化佈建stsToken、accessKeyId、accessKeySecret的函數。傳回值必須是包含stsToken、accessKeyId、accessKeySecret的對象。

[refreshSTSTokenInterval] {number}：STS令牌重新整理間隔時間（毫秒）。應小於STS資訊的到期間隔，預設為300000毫秒（5分鐘）。

[bucket] {String}：您想訪問的預設Bucket。如果沒有Bucket，請先使用putBucket()建立一個。

[endpoint] {String}：OSS地區網域名稱。優先順序高於region。根據需要設定為外網網域名稱、內網網域名稱或加速網域名稱等，請參考終端節點列表。

[region] {String}：Bucket資料所在的地區位置，預設為oss-cn-hangzhou。

[internal] {Boolean}：是否通過阿里雲內網訪問OSS，預設為false。如果您的伺服器也在阿里雲上運行，可以設定為true以節省大量費用。

[secure] {Boolean}：指示OSS用戶端使用HTTPS（secure: true）還是HTTP（secure: false）協議。

[timeout] {String|Number}：針對所有操作的執行個體層級逾時時間，預設為60秒。

[cname] {Boolean}：預設為false，使用自訂網域名訪問OSS。如果為true，則可以在endpoint欄位中填寫自訂網域名。

[isRequestPay] {Boolean}：預設為false，表示是否開啟Bucket的要求者支付功能，如果為true，會向OSS伺服器發送頭部'x-oss-request-payer': 'requester'。

[useFetch] {Boolean}：預設為false，僅在瀏覽器環境中生效。如果為true，意味著使用fetch模式上傳對象，否則使用XMLHttpRequest。

[retryMax] {Number}：當請求因網路錯誤或逾時出錯時自動重試發送請求的最大次數。使用putStream時不支援重試。

[authorizationV4] {Boolean}：使用V4簽名。預設為false。

基本用法

const OSS = require('ali-oss');

const store = new OSS({
  region: 'yourRegion',
  authorizationV4: true,
  accessKeyId: 'your access key',
  accessKeySecret: 'your access secret',
  stsToken: 'yourSecurityToken',
  bucket: 'your bucket name',
});

使用加速訪問endpoint

const OSS = require('ali-oss');

const store = new OSS({
  region: 'yourRegion',
  authorizationV4: true,
  accessKeyId: 'your access key',
  accessKeySecret: 'your access secret',
  stsToken: 'yourSecurityToken',
  bucket: 'your bucket name',
  endpoint: 'oss-accelerate.aliyuncs.com',
});

使用自訂訪問方式

const OSS = require('ali-oss');

const store = new OSS({
  region: 'yourRegion',
  authorizationV4: true,
  stsToken: 'yourSecurityToken',
  accessKeyId: 'your access key',
  accessKeySecret: 'your access secret',
  cname: true,
  endpoint: 'your custome domain',
});

使用STS Token訪問

const OSS = require('ali-oss');

const store = new OSS({
  region: 'yourRegion',
  authorizationV4: true,
  accessKeyId: 'your STS key',
  accessKeySecret: 'your STS secret',
  stsToken: 'your STS token',
  refreshSTSToken: async () => {
    const info = await fetch('you sts server');
    return {
      accessKeyId: info.accessKeyId,
      accessKeySecret: info.accessKeySecret,
      stsToken: info.stsToken,
    };
  },
  refreshSTSTokenInterval: 300000,
});

使用流重新嘗試請求

for (let i = 0; i <= store.options.retryMax; i++) {
  try {
    const result = await store.putStream('<example-object>', fs.createReadStream('<example-path>'));
    console.log(result);
    break; // break if success
  } catch (e) {
    console.log(e);
  }
}

使用V4簽名，並使用可選的additionalHeaders選項（類型為字串數組），其中的值需要包含在標題中

const OSS = require('ali-oss');

const store = new OSS({
  accessKeyId: 'your access key',
  accessKeySecret: 'your access secret',
  bucket: 'your bucket name',
  region: 'oss-cn-hangzhou',
  authorizationV4: true ,
  stsToken: 'yourSecurityToken',
});

try {
  const bucketInfo = await store.getBucketInfo('your bucket name');
  console.log(bucketInfo);
} catch (e) {
  console.log(e);
}

try {
  const putObjectResult = await store.put('your bucket name', 'your object name', {
    headers: {
      // The headers of this request
      header1: 'value1',
      header2: 'value2',
    },
    // The keys of the request headers that need to be calculated into the V4 signature. Please ensure that these additional headers are included in the request headers.
    additionalHeaders: ['additional header1', 'additional header2'],
  });
  console.log(putObjectResult);
} catch (e) {
  console.log(e);
}