Javascript SDK如何快速开始使用_网盘与相册服务(PDS)-阿里云帮助中心

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。

重要

注意：从 1.0.0 开始，不再支持 HostingMode（托管模式）相关功能。

说明

node版本依赖：>=16.15.0

PDS资源说明

Domain下的资源：

Domain/
  |-- Group                # 分组或团队
  |-- User                 # 用户
  |-- Account              # 账号
  |-- Drive                # 云盘（网盘）
  |-- ShareLink            # 分享链接 
  |-- File                 # 文件相关（新版共享权限，回收站）

一个 User 绑定多个 Account，一个Account 即一种登录方式，如：钉钉登录。
Group 下可以嵌套 Group 或者 User （通过 Membership）。

Group/
  |-- Group
  |-- User

Drive 的 Owner 可以为一个 Group 或者 User。

File 必属于一个 Drive。

Drive/          # 云盘
  |-- File

安装

执行以下命令安装：

npm i -S aliyun-pds-js-sdk

注意：请先确保已经安装 Node.js >= 16.15.0。

引入

(1) 在 Vue 或 React 项目中使用

import {PDSClient} from 'aliyun-pds-js-sdk/browser'

(2) 在 Node.js 中使用

const { PDSClient } = require('aliyun-pds-js-sdk')

(3) 在浏览器中以 script 标签引入

npm 安装后，在 node_modules/aliyun-pds-js-sdk/dist/browser/ 目录下，有打包好的 aliyun-pds-js-sdk.umd.cjs 文件，可以复制到你自己的静态服务或CDN上，然后以 script 标签引入。

<script src="/path/to/dist/browser/aliyun-pds-js-sdk.umd.cjs"></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`,
}

const pds = new PDSClient(config)

let { items=[], next_marker } = await pds.listDrives({ limit:10 })

关于构造参数 config 详解，请看这里：PDSClient类。