阿里雲團隊努力不懈,力求將最新的技術內容更快地以您最熟悉的語言呈現。本文由簡體中文內容自動轉碼而成,過程無人工干預。阿里雲不保證此自動轉碼的準確性、完整性及時效性。因轉碼造成的任何內容錯誤及因此可能帶來的損失,阿里雲概不負責,敬請見諒。本文内容請以簡體中文版本為準。
全部產品
Search
文件中心

安裝

更新時間: Oct 30, 2018

目前官網文檔中的demo都是基於SDK 6.X,版本低於6.X的可參考 5.X開發文檔, 升級6.X請移步升級文檔

要求

  • 開通阿里雲OSS服務,如果您還沒不瞭解阿里雲OSS服務,請登入OSS產品首頁瞭解。

  • 建立AccessKeyId和AccessKeySecret,由於雲帳號AccessKey有所有API存取權限,建議遵循阿里雲安全最佳實務。如果部署在服務端可以使用RAM子帳號或STS來進行API訪問或日常運維管控操作,如果部署在用戶端請使用STS方式來進行API訪問。詳情請參見存取控制

環境要求

OSS NodeJS SDK基於Node.js環境構建。

使用方式

OSS NodeJS SDK同時支援同步和非同步使用方式,參考這篇文章

  • 同步方式:基於asyncawait方式, 非同步編程同步化
  • 非同步方式:類似callback的方式,API介面返回Promise,使用.then()處理返回結果,使用.catch()處理錯誤

無論同步方式還是非同步方式中,均使用new OSS()建立client。

下面分別舉例,先上傳一個檔案,然後立即下載這個檔案:

同步方式

  1. let client = new OSS(...);
  2. async function put () {
  3. try {
  4. let r1 = await.put('object','tmp/file');
  5. console.log('put success: %j', r1);
  6. let r2 = await client.get('object');
  7. console.log('get success: %j', r2);
  8. } catch(e) {
  9. console.error('error: %j', err);
  10. }
  11. }
  12. put();

非同步方式

  1. let client = new OSS(...);
  2. client.put('object', '/tmp/file').then(function (r1) {
  3. console.log('put success: %j', r1);
  4. return client.get('object');
  5. }).then(function (r2) {
  6. console.log('get success: %j', r2);
  7. }).catch(function (err) {
  8. console.error('error: %j', err);
  9. });

安裝

使用Node.js

支援的Node.js版本:

Node.js >= 8.0.0
如果需要在 Node.js < 8 的環境中使用,請使用 ali-oss 4.x版本。

首先使用npm安裝SDK的開發包:

  1. npm install ali-oss

然後在你的程式中使用:

  1. let OSS = require('ali-oss');
  2. let client = new OSS({
  3. region: '<oss region>',
  4. //雲帳號AccessKey有所有API存取權限,建議遵循阿里雲安全最佳實務,部署在服務端使用RAM子帳號或STS,部署在用戶端使用STS。
  5. accessKeyId: '<Your accessKeyId>',
  6. accessKeySecret: '<Your accessKeySecret>',
  7. bucket: '<Your bucket name>'
  8. });

如果使用npm遇到網路問題,可以使用淘寶提供的npm鏡像:cnpm