Object Storage Service：Node.js快速入門

前提條件

已完成初始化。具體操作，請參見初始化。

查看儲存空間列表

以下代碼用於查看儲存空間列表。

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

async function listBuckets() {
  try {
    // 列舉當前帳號所有地區下的儲存空間。
    const result = await client.listBuckets();
    console.log(result);
  } catch (err) {
    console.log(err);
  }
}

listBuckets();

查看檔案清單

以下代碼用於查看檔案清單。

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

async function list () {
    // 不帶任何參數，預設最多返回100個檔案。
    const result = await client.list();
    console.log(result);
}

list();

上傳檔案

以下代碼用於上傳單個檔案。

const OSS = require('ali-oss')
const path=require("path")

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,
  // 填寫Bucket名稱。
  bucket: 'examplebucket',
});

// 自訂要求標頭
const headers = {
  // 指定Object的儲存類型。
  'x-oss-storage-class': 'Standard',
  // 指定Object的存取權限。
  'x-oss-object-acl': 'private',
  // 通過檔案URL訪問檔案時，指定以附件形式下載檔案，下載後的檔案名稱定義為example.txt。
  'Content-Disposition': 'attachment; filename="example.txt"',
  // 設定Object的標籤，可同時設定多個標籤。
  'x-oss-tagging': 'Tag1=1&Tag2=2',
  // 指定PutObject操作時是否覆蓋同名目標Object。此處設定為true，表示禁止覆蓋同名Object。
  'x-oss-forbid-overwrite': 'true',
};

async function put () {
  try {
    // 填寫OSS檔案完整路徑和本地檔案的完整路徑。OSS檔案完整路徑中不能包含Bucket名稱。
    // 如果本地檔案的完整路徑中未指定本地路徑，則預設從樣本程式所屬專案對應本地路徑中上傳檔案。
    const result = await client.put('exampleobject.txt', path.normalize('D:\\localpath\\examplefile.txt')
    // 自訂headers
    ,{headers}
    );
    console.log(result);
  } catch (e) {
    console.log(e);
  }
}

put();

下載檔案

以下代碼用於下載單個檔案。

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,
  // 填寫Bucket名稱。
  bucket: 'examplebucket'
});

async function get () {
  try {
    // 填寫Object完整路徑和本地檔案的完整路徑。Object完整路徑中不能包含Bucket名稱。
    // 如果指定的本地檔案存在會覆蓋，不存在則建立。
    // 如果未指定本地路徑，則下載後的檔案預設儲存到樣本程式所屬專案對應本地路徑中。
    const result = await client.get('exampleobject.txt', 'D:\\localpath\\examplefile.txt');
    console.log(result);
  } catch (e) {
    console.log(e);
  }
}

get(); 

刪除單個檔案

以下代碼用於刪除單個檔案。

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

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

async function deleteObject() {
  try {
    // 填寫Object完整路徑。Object完整路徑中不能包含Bucket名稱。
    const result = await client.delete('exampleobject.txt');
    console.log(result);
  } catch (error) {
    console.log(error);
  }
}

deleteObject();

相關文檔

• 查看儲存空間列表

  • 關於查看儲存空間列表的完整範例程式碼，請參見GitHub樣本。

  • 關於查看儲存空間列表的API介面說明，請參見ListBuckets（GetService）。

• 查看檔案清單

  • 關於查看檔案清單的完整範例程式碼，請參見GitHub樣本。

  • 關於查看檔案清單的API介面說明，請參見GetBucket (ListObjects)。

• 上傳檔案

  • 關於上傳檔案的完整範例程式碼，請參見GitHub樣本。

  • 關於上傳檔案的API介面說明，請參見PutObject。

• 下載檔案

  • 關於下載檔案的完整範例程式碼，請參見GitHub樣本。

  • 關於下載檔案的API介面說明，請參見GetObject。

• 刪除檔案

  • 關於刪除單個檔案的完整範例程式碼，請參見GitHub樣本。

  • 關於刪除單個檔案的API介面說明，請參見DeleteObject。