通過Node.js初始化與OSS服務建立串連 - Object Storage Service

Client是OSS Node.js的用戶端，用於管理儲存空間和檔案等OSS資源。使用Node.js SDK發起OSS請求時，您需要初始化一個Client執行個體，並根據需要修改預設配置項。

建立Client

V4簽名（推薦）

推薦使用更安全的V4簽名演算法。使用V4簽名初始化時，需要聲明authorizationV4。OSS Node.js SDK 6.20.0及以上版本支援V4簽名。

以使用OSS網域名稱初始化時使用V4簽名為例，其他通過自訂網域名等初始化的情境可參考以下樣本執行相應修改。

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

const client = new OSS({
  // 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
  accessKeyId: process.env.OSS_ACCESS_KEY_ID,
  accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,
  // yourRegion填寫Bucket所在地區。以華東1（杭州）為例，Region填寫為oss-cn-hangzhou。
  region: 'yourRegion',
  authorizationV4: true,
  // yourBucketName填寫Bucket名稱。
  bucket: 'yourBucketName',
});

V1簽名（不推薦）

重要

阿里雲Object Storage Service自2024年12月1日起不再對新使用者（即新UID ）開放使用V1簽名，並將於2025年06月01日起停止更新與維護且不再對新增Bucket開放使用V1簽名。請儘快切換到V4簽名，避免影響服務。更多資訊，請參見公告說明。

使用OSS網域名稱建立Client

以下代碼用於使用OSS網域名稱初始化。

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

const client = new OSS({
  // yourRegion填寫Bucket所在地區。以華東1（杭州）為例，Region填寫為oss-cn-hangzhou。
  region: 'yourRegion',
  // 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
  accessKeyId: process.env.OSS_ACCESS_KEY_ID,
  accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,
  // yourBucketName填寫Bucket名稱。
  bucket: 'yourBucketName',
});

使用自訂網域名建立Client

以下代碼用於使用自訂網域名建立Client。關於使用自訂網域名訪問OSS的更多資訊，請參見綁定自訂網域名至Bucket預設網域名稱。

重要

使用自訂網域名無法使用client.listBuckets()方法。

const OSS = require('ali-oss')

const client = new OSS({  
 // 使用自訂網域名作為Endpoint。
 endpoint: 'http://img.example.com', 
 // 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
 accessKeyId: process.env.OSS_ACCESS_KEY_ID,
 accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,
 cname: true,
 // yourBucketName填寫Bucket名稱。
 bucket: 'yourBucketName',
});

配置Client

您可以在初始化Client時按需添加配置項，例如通過timeout指定請求逾時時間，通過stsToken指定臨時訪問憑證等。關於Node.js支援的配置項以及配置樣本，請參見配置項。