云盘_网盘与相册服务(PDS)-阿里云帮助中心

提供云盘的 CURD操作和其它一些方法。以下所有方法中的 options 参数是额外请求配置，详见 AxiosRequestConfig。

getQuota 方法

重要

仅标准模式（仅企业版）支持。

警告

托管模式不支持。

（企业版，空间有限时）可以通过此接口获取剩余空间。

const result = await client.getQuota(options)

举例

const {
  size_quota, 
  size_used, 
  user_count_quota, 
  user_count_used 
} = await client.getQuota()

参数说明

字段	类型	必选	说明
options	AxiosRequestConfig		其它配置项。

字段	类型	必选	说明
result	IQuotaRes		返回结果。

IQuotaRes

字段	类型	说明
size_quota	number	购买的总空间。
size_used	number	已使用的空间。
user_count_quota	number	购买的总用户数。
user_count_used	number	已有用户数。

createDrive 方法

说明

标准模式和托管模式都支持。

创建云盘。

const result = await client.createDrive(params, options)

举例

const { drive_id } = await client.createDrive({
  drive_name: 'my_drive', // 云盘名称
  owner: 'xxxxx', // 用户ID
});

参数说明

字段	类型	必选	说明
params	ICreateDriveReq	是	创建 drive 的参数。
options	AxiosRequestConfig		其它配置项。

ICreateDriveReq

字段	类型	必选	说明
default	boolean		（仅标准模式有效）是否设置为默认drive。一个用户只允许设置一个默认drive。默认：`false`。
drive_name	string	是	云盘名称。
owner	string	是	云盘所属的 `user_id` 或 `group_id`。
owner_type	string		可选值为：`group`, `user`。默认：`user`。
description	string		描述信息。
total_size	number	是	云盘大小, 单位 `Byte`。如果设置 -1 代表不限制大小。
store_id	string	（托管模式必选）	存储空间ID。
relative_path	string	（托管模式必选）	Drive 存储基于 `store` 的相对路径。

返回值

字段	类型	必选	说明
result	ICreateDriveRes	是	创建成功的返回信息。

ICreateDriveRes

字段	类型	必选	说明
drive_id	string	是	云盘ID。
domain_id	string	是	Domain ID。

updateDrive 方法

说明

标准模式和托管模式都支持。

更新云盘信息。

const result = await client.updateDrive(params, options)

参数说明

字段	类型	必选	说明
params	IUpdateDriveReq	是	更新 drive 传递的参数。
options	AxiosRequestConfig		其它配置项。

IUpdateDriveReq

字段	类型	必选	说明
drive_id	string	是	要更新的 drive 的 ID。
description	string		描述。
total_size	string		更新云盘大小, 单位 `Byte`。如果设置 -1 代表不限制大小。
drive_name	string		云盘名称。
status	string		云盘状态，取值：`enabled, disabled` 默认：`enabled`。

返回值

字段	类型	必选	说明
result	IDriveItem	是	更新之后的 drive 信息。

IDriveItem

字段	类型	必选	说明
drive_id	string	是	云盘 ID。
domain_id	string	是	所属domain ID。
creator	string	是	创建人user_id。
drive_name	string	是	云盘名称。
owner_type	string	是	值为 `group` , `user`。
drive_type	string	是	云盘类型，取值为 `normal`, `large`。
owner	string	是	所属 `user_id` 或者`group_id`。
relative_path	string	（托管模式必选）	Drive存储基于store的相对路径。
status	string	是	云盘状态。取值：`enabled, disabled`。
store_id	string	（托管模式必选）	存储空间ID。
total_size	number	是	总大小，单位：`Byte`。
used_size	number	是	已使用大小，单位：`Byte`。
description	string	是	描述。
created_at	Date	是	创建时间。
subdomain_id	string		Subdomain 的 ID。开通Subdomain的 Domain才有。

deleteDrive 方法

说明

标准模式和托管模式都支持。

删除云盘。

await client.deleteDrive(params, options)

参数说明

字段	类型	必选	说明
params	object	是	要删除的云盘的 ID，例如 `{ drive_id: '123' }`。
options	AxiosRequestConfig	否	其它配置项。

params

字段	类型	必选	说明
drive_id	string	是	要删除的云盘的 ID。

返回值

删除成功没有返回值，如果删除失败会抛出异常，可根据异常信息具体分析原因。

getDrive 方法

说明

标准模式和托管模式都支持。

根据云盘ID 查询该云盘的详细信息。

const result = await client.getDrive(params, options)

举例

const drive_id = '123'
const result = await client.getDrive({drive_id})

assert(result.drive_id==drive_id) // true

参数说明

字段	类型	必选	说明
params	object	是	要查询的云盘的 ID，例如 `{ drive_id: '123' }`。
options	AxiosRequestConfig		其它配置项。

字段	类型	必选	说明
result	IDriveItem	是	返回云盘信息。

searchDrives 方法

重要

标准模式支持。

警告

托管模式不支持。

根据特定字段来查询云盘信息（模糊搜索）。

const result = await client.searchDrives(params, options)

参数说明

字段	类型	必选	说明
params	ISearchDrivesReq		查询参数，默认为 {}。
options	AxiosRequestConfig		其它配置项。

ISearchDriveReq

字段	类型	必选	说明
drive_name	string		根据云盘名称查询。
limit	number		返回数据最大条数,范围：[1-100]，默认：100。
marker	string		查询开始标记。
owner_type	string		取值范围：`group`, `user`。

返回值

字段	类型	必选	说明
result	IListRes	是	结果。

IListRes

字段	类型	必选	说明
items	IDriveItemRes[]	是	查询到的云盘信息列表。
next_marker	string		下一页查询标记。

listDrives 方法

说明

标准模式和托管模式都支持。

获取用户云盘列表。

const result = await client.listDrives(params, options)

参数说明

字段	类型	必选	说明
params	IListDrivesReq		查询参数，不传默认为 {}。
options	AxiosRequestConfig		其它配置项。

IListDrivesReq

字段	类型	必选	说明
limit	string		返回数据最大条数,范围：[1-100]，默认：100。
marker	string		查询开始标记。
owner_type	string		取值范围 `group`, `user`。
owner	string		`group_id` 或者 `user_id`。

返回值

字段	类型	必选	说明
result	IListRes	是	结果

IListRes

字段	类型	必选	说明
items	IDriveItemRes[]	是	查询到的云盘信息列表，`items` 中每一项的具体字段可参考 `IDriveItemRes`。
next_marker	string		下一页查询标记。

listMyDrives 方法

说明

标准模式和托管模式都支持。

获取当前用户的云盘列表。

const result = await client.listMyDrives(params, options)

参数说明

字段	类型	必选	说明
params	object		查询参数，不传默认为 {}。
options	AxiosRequestConfig		其它配置项。

params

字段	类型	必选	说明
limit	string		返回数据最大条数,范围：[1-100]，默认：100。
marker	string		查询开始标记。

返回值

字段	类型	必选	说明
result	IListRes	是	结果。

IListRes

字段	类型	必选	说明
items	IDriveItemRes[]	是	查询到的云盘信息列表。
next_marker	string		下一页查询标记。

listMyGroupDrives 方法

重要

仅标准模式支持。

警告

托管模式不支持。

获取当前用户所在的组织云盘信息。

const result = await client.listMyGroupDrives(params, options)

参数说明

字段	类型	必选	说明
params	IListReq		查询参数，不传默认为 {}。
options	AxiosRequestConfig		其它配置项。

IListReq

字段	类型	必选	说明
limit	string		返回数据最大条数,范围：[1-100]，默认：100。
marker	string		查询开始标记。

返回值

字段	类型	必选	说明
result	IListRes	是	结果。

IListRes

字段	类型	必选	说明
items	IDriveItemRes[]	是	查询到的云盘信息列表。
next_marker	string		下一页查询标记。