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

注意事項

• 初始化OSSClient前，您需要配置訪問憑證，本文以從環境變數讀取存取憑證為例，詳情請參見配置訪問憑證（Node.js SDK）。

• 關於OSS支援的Region與Endpoint的對應關係，請參見地區和Endpoint。

• 關於建立RAM使用者的AccessKey，請參見建立AccessKey。

前置條件

1. 建立有OSS系統管理權限的RAM使用者AccessKey。

   使用ROS指令碼快速建立有OSS系統管理權限的RAM使用者AccessKey

   在Resource Orchestration Service控制台的建立資源棧頁面的安全確認下，勾選確認，然後單擊建立。

   

   建立完成後，在輸出中，複製建立的AccessKey。

   

2. 使用RAM使用者AccessKey配置環境變數。

   Linux

   1. 在命令列介面執行以下命令來將環境變數設定追加到~/.bashrc 檔案中。

      echo "export OSS_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.bashrc
      echo "export OSS_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.bashrc

      1. 執行以下命令使變更生效。

         source ~/.bashrc

      2. 執行以下命令檢查環境變數是否生效。

         echo $OSS_ACCESS_KEY_ID
         echo $OSS_ACCESS_KEY_SECRET

   macOS

   1. 在終端中執行以下命令，查看預設Shell類型。

      echo $SHELL

      1. 根據預設Shell類型進行操作。

         Zsh

         1. 執行以下命令來將環境變數設定追加到 ~/.zshrc 檔案中。

            echo "export OSS_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.zshrc
            echo "export OSS_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.zshrc

         2. 執行以下命令使變更生效。

            source ~/.zshrc

         3. 執行以下命令檢查環境變數是否生效。

            echo $OSS_ACCESS_KEY_ID
            echo $OSS_ACCESS_KEY_SECRET

         Bash

         1. 執行以下命令來將環境變數設定追加到 ~/.bash_profile 檔案中。

            echo "export OSS_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.bash_profile
            echo "export OSS_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.bash_profile

         2. 執行以下命令使變更生效。

            source ~/.bash_profile

         3. 執行以下命令檢查環境變數是否生效。

            echo $OSS_ACCESS_KEY_ID
            echo $OSS_ACCESS_KEY_SECRET

   Windows

   CMD

   1. 在CMD中運行以下命令。

      setx OSS_ACCESS_KEY_ID "YOUR_ACCESS_KEY_ID"
      setx OSS_ACCESS_KEY_SECRET "YOUR_ACCESS_KEY_SECRET"

      1. 運行以下命令，檢查環境變數是否生效。

         echo %OSS_ACCESS_KEY_ID%
         echo %OSS_ACCESS_KEY_SECRET%

   PowerShell

   1. 在PowerShell中運行以下命令。

      [Environment]::SetEnvironmentVariable("OSS_ACCESS_KEY_ID", "YOUR_ACCESS_KEY_ID", [EnvironmentVariableTarget]::User)
      [Environment]::SetEnvironmentVariable("OSS_ACCESS_KEY_SECRET", "YOUR_ACCESS_KEY_SECRET", [EnvironmentVariableTarget]::User)

      1. 運行以下命令，檢查環境變數是否生效。

         [Environment]::GetEnvironmentVariable("OSS_ACCESS_KEY_ID", [EnvironmentVariableTarget]::User)
         [Environment]::GetEnvironmentVariable("OSS_ACCESS_KEY_SECRET", [EnvironmentVariableTarget]::User)

3. 參考上述方式修改系統內容變數後，請重啟或重新整理您的編譯運行環境，包括IDE、命令列介面、其他傳統型應用程式及後台服務，以確保最新的系統內容變數成功載入。

預設配置樣本

以下程式碼範例示範了如何使用V4簽名和V1簽名配置OSSClient。

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: 'oss-cn-hangzhou',
  // 使用V4簽名演算法
  authorizationV4: true,
  // yourBucketName填寫Bucket名稱。
  bucket: 'yourBucketName',
  // yourEndpoint填寫Bucket所在地區對應的公網Endpoint。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
  endpoint: 'https://oss-cn-hangzhou.aliyuncs.com',
});

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

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

常見情境配置樣本

如果您有配置其它網域名稱的需求，請參考以下程式碼範例。請注意，以下程式碼範例預設使用V4簽名以及RAM使用者的AK資訊。

內網網域名稱配置樣本

當您的應用部署在阿里雲的ECS執行個體上，並且需要頻繁訪問同地區的OSS資源時，使用內網網域名稱可以降低流量成本並提高訪問速度。

以下是使用OSS內網網域名稱配置OSSClient的範例程式碼。

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: 'oss-cn-hangzhou',
  //使用V4簽名
  authorizationV4: true,
  // yourBucketName填寫Bucket名稱。
  bucket: 'yourBucketName',
  // yourEndpoint填寫Bucket所在地區對應的內網Endpoint。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou-internal.aliyuncs.com。
  endpoint: 'yourEndpoint',
});

自訂網域名配置樣本

以下是使用自訂網域名配置OSSClient的範例程式碼。

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: 'oss-cn-hangzhou',
  // 使用V4簽名
  authorizationV4: true,
  // yourBucketName填寫Bucket名稱。
  bucket: 'yourBucketName',
  // yourEndpoint請填寫您的自訂網域名。例如https://static.example.com。
  endpoint: 'yourEndpoint',
  // 設定true開啟CNAME選項。
  cname: true,
});

傳輸加速網域名稱配置樣本

以下是使用傳輸加速網域名稱配置OSSClient的範例程式碼。

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: 'oss-cn-hangzhou',
  //使用V4簽名
  authorizationV4: true,
  // yourBucketName填寫Bucket名稱。
  bucket: 'yourBucketName',
  // yourEndpoint請填寫傳輸加速網域名稱。例如'oss-accelerate.aliyuncs.com'
  endpoint: 'oss-accelerate.aliyuncs.com',
});

相關文檔

關於OSSClient的更多配置選項，請參見官網樣本。