Object Storage Service:初期化 (Browser.js SDK)

accessKeyId {String}：Alibaba Cloud 管理コンソールから取得した AccessKey ID。

accessKeySecret {String}：Alibaba Cloud 管理コンソールから取得した AccessKey Secret。

[stsToken] {String}：一時的な権限付与に使用される Security Token Service (STS) トークン。

[refreshSTSToken] {Function}：STS トークンの有効期限が切れたときに、stsToken、accessKeyId、accessKeySecret を自動的に設定する関数。この関数は、stsToken、accessKeyId、accessKeySecret を含むオブジェクトを返す必要があります。

[refreshSTSTokenInterval] {number}：STS トークンのリフレッシュ間隔 (ミリ秒単位)。この値は、STS トークンの有効期間より短くする必要があります。デフォルト値は 300,000 ミリ秒 (5 分) です。

[bucket] {String}：アクセスするデフォルトのバケット。バケットが存在しない場合は、putBucket() 操作を呼び出して作成できます。

[endpoint] {String}：OSS のリージョン固有のドメイン名。このパラメーターは region パラメーターよりも優先度が高くなります。必要に応じて、このパラメーターをパブリックエンドポイント、内部の同一リージョンエンドポイント、または CDN ドメイン名に設定できます。詳細については、エンドポイントのリストをご参照ください。

[region] {String}：バケットが配置されているリージョン。デフォルト値は oss-cn-hangzhou です。

[internal] {Boolean}：Alibaba Cloud 内部ネットワーク経由で OSS にアクセスするかどうかを指定します。デフォルト値は false です。ご利用のサーバーも Alibaba Cloud 上で実行されている場合は、このパラメーターを true に設定すると、データ転送コストを削減できます。

[secure] {Boolean}：OSS クライアントが HTTPS (secure: true) プロトコルと HTTP (secure: false) プロトコルのどちらを使用するかを指定します。

[timeout] {String|Number}：すべての操作のタイムアウト期間 (秒単位)。デフォルト値は 60 です。

[cname] {Boolean}：カスタムドメイン名を使用して OSS にアクセスするかどうかを指定します。デフォルト値は false です。このパラメーターを true に設定する場合は、endpoint フィールドにカスタムドメイン名を指定する必要があります。

[isRequestPay] {Boolean}：バケットのリクエスタ支払い機能を有効にするかどうかを指定します。デフォルト値は false です。このパラメーターを true に設定すると、'x-oss-request-payer': 'requester' ヘッダーが OSS サーバーに送信されます。

[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',
});

高速化エンドポイントの使用

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 トークンを使用したアクセス

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; // 成功した場合は中断
  } 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: {
      // このリクエストのヘッダー
      header1: 'value1',
      header2: 'value2',
    },
    // V4 署名の計算に含めるリクエストヘッダーのキー。これらの追加ヘッダーがリクエストヘッダーに含まれていることを確認してください。
    additionalHeaders: ['additional header1', 'additional header2'],
  });
  console.log(putObjectResult);
} catch (e) {
  console.log(e);
}