前提條件

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

查看存儲空間列表

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

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。