aliyun-pds-js-sdk 是PDS官方的推出的js sdk,提供PDS資源的基本操作方法,開發人員可以很方便的開發PDS網盤應用。除了上傳,下載,複製,移動,刪除等檔案基本操作外,還提供了Drive,Share,Group等資源的基本操作,同時支援瀏覽器和Node.js(electron或node服務)端。
github 開源地址:https://github.com/aliyun/aliyun-pds-js-sdk/tree/0.2.11。
PDS資源說明
Domain下的資源:
Domain/
|-- Group & Membership # 分組或團隊
|-- User # 使用者
|-- Account # 帳號
|-- Drive # 雲端硬碟(網盤)
|-- Share # 共用目錄(最新版已經廢棄,請使用File中的共用API)
|-- ShareLink # 分享連結
|-- File # 檔案相關(新版共用許可權,資源回收筒)2. Group 下可以嵌套 Group 或者 User (通過 Membership)。
Group/
|-- Group
|-- User3. Drive 的 Owner 可以為一個 Group 或者 User。
4. Share (share目前只有託管模式支援) 的 Owner 可以為一個 User。
5. File 必屬於一個 Drive 或 Share(share目前只有託管模式支援)。
Drive/ # 雲端硬碟
|-- File
Share/ # 共用目錄(僅託管模式支援)
|-- File6. 標準模式(StandardMode)和託管模式(HostingMode)下 File 主鍵的區別:
* 標準模式: key 為 file_id
Drive/ # 雲端硬碟
|-- File (type=='folder', file_id="xxxxxxxx1") # 目錄(檔案夾)
|-- File (type=='file', file_id="xxxxxxxx2") # 檔案
* 託管模式: key 為 file_path
Drive|Share/ # 雲端硬碟/共用目錄
|-- File (type=='folder',file_path:'/abc/') # 目錄(檔案夾)
|-- File (type=='file',file_path:'/abc/1.jpg') # 檔案安裝
執行以下命令安裝:
npm i -S aliyun-pds-js-sdk@0.2.11注意:請先確保已經安裝 Node.js。
引入
(1) 在 Vue 或 React 專案中使用
import {PDSClient} from 'aliyun-pds-js-sdk' (2) 在 Node.js 中使用
const { PDSClient } = require('aliyun-pds-js-sdk')(3) 在瀏覽器中以 script 標籤引入
npm 安裝後,在 node_modules/aliyun-pds-js-sdk/dist/ 目錄下,有打包好的 aliyun-pds-js-sdk.min.js 檔案,可以複製到你自己的靜態服務或CDN上,然後以 script 標籤引入。
<script src="/path/to/aliyun-pds-js-sdk.min.js"></script>const { PDSClient } = window.PDS_SDK調用舉例
PDS API 的功能都整合在 PDSClient 類執行個體方法上,使用時只需 new 一個 PDSClient 執行個體,即可通過該執行個體的方法來調用 PDS 的各種 API。
const domain_id = "您的domainID" // 如:bj123
const config = {
token_info: {...},
api_endpoint: `https://${domain_id}.api.aliyunpds.com`,
auth_endpoint: `https://${domain_id}.api.aliyunpds.com`,
}
const pds = new PDSClient(config)
let { items=[], next_marker } = await pds.listDrives({ limit:10 })
關於構造參數
config詳解,請看這裡:PDSClient 類。