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

仅适用于托管模式（HostingMode）。提供文件共享的一些操作方法，有创建共享、更新共享、删除共享、查询共享等。以下所有方法中的 options 参数是额外请求配置，详见 AxiosRequestConfig。

listShares 方法

警告

标准模式不支持

重要

托管模式支持

获取共享列表。

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

参数说明

字段	类型	必选	说明
params	IListSharesReq		默认为 {}
options	AxiosRequestConfig		其它配置项

IListSharesReq

字段	类型	必选	说明
limit	number		一次查询多少条数据, 0-100
marker	string		标记
creator	string		按共享者查询
owner	string		按共享接收者查询

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

IListRes

字段	类型	必选	说明
items	IShareItem[]	是	查询到的文件信息列表，items 中每一项的具体字段可查看下面关于 IShareItem 的说明
next_marker	string		下一页标记

IShareItem

字段	类型	必选	说明
drive_id	string	是	云盘id
domain_id	string	是	domain ID
created_at	Date	是	文件创建时间
updated_at	Date	是	文件更新时间
status	string	是	文件状态, available \| enabled
creator	string	是	创建人
description	string		描述信息
expiration	Date		到期时间
expired	boolean		是否到期
owner	string	是	共享人id
owner_type	string	是	共享人类型
permissions	string[]		权限列表
share_file_path	string		共享文件路径
share_id	string	是	共享id
share_name	string	是	共享文件的名称
share_policy	array		共享给他人时具有的操作权限列表

listReceivedShares 方法

警告

标准模式不支持

重要

托管模式支持

查询收到的共享文件信息。

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

参数

字段	类型	必选	说明
params	IListReceivedSharedsReq		默认为 {}
options	AxiosRequestConfig		其它配置项

IListReceivedSharedsReq

字段	类型	必选	说明
limit	number		一次查询多少条数据, 0-100
marker	string		标记
owner	string		用户ID

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

IListRes

字段	类型	必选	说明
items	IShareItem[]	是	查询到的文件信息列表，items 中每一项的具体字段可参考关于 IShareItem 的说明
next_marker	string		分页标记

createShare 方法

警告

标准模式不支持

重要

托管模式支持

创建共享

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

参数

字段	类型	必选	说明
params	ICreateShareReq	是	创建共享的信息
options	AxiosRequestConfig		其它配置项

ICreateShareReq

字段	类型	必选	说明
drive_id	string		云盘 id
description	string		描述信息
expiration	Date		到期时间
owner	string		共享者
permissions	string[]		权限列表
share_file_path	string		共享的文件路径，
share_name	string		共享的文件名称
status	string		状态 enabled

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

ICreateShareRes

字段	类型	必选	说明
share_id	string	是	创建成功的共享 id
domain_id	string	是	domain ID

updateShare 方法

警告

标准模式不支持

重要

托管模式支持

更新共享

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

参数

字段	类型	必选	说明
params	IUpdateShareReq	是	参数格式请查看 IUpdateShareReq
options	AxiosRequestConfig		其它配置项

IUpdateShareReq

字段	类型	必选	说明
share_id	string	是	Share ID
description	string		描述信息
expiration	Date		到期时间
permissions	string[]		权限列表
share_name	string		共享的文件名称
status	string		状态 enabled
share_policy	TSharePolicyItem[]		附加权限配置

TSharePolicyItem

字段	类型	必选	说明
file_path	string	是	附加权限文件路径，可以为目录或文件的路径
permission_list	string[]		具体权限列表。
premission_type	string		权限类型，取值范围：allow, deny
permission_inheritable	boolean		是否继承父级目录的权限

字段	类型	必选	说明
result	IShareItem	是	更新成功的返回信息

deleteShare 方法

警告

标准模式不支持

重要

托管模式支持

删除/取消共享

await client.deleteShare(params, options)

参数

字段	类型	必选	说明
params	IDeleteShareReq	是	要删除的文件信息
options	AxiosRequestConfig		其它配置项

IDeleteShareReq

字段	类型	必选	说明
share_id	string	是	共享id

删除成功，没有返回值，失败则抛出异常信息。

getShare 方法

警告

标准模式不支持

重要

托管模式支持

根据共享 id 获取共享信息

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

参数

字段	类型	必选	说明
params	IGetShareReq	是	需要查询的id，例： { share_id: '123' }
options	AxiosRequestConfig		其它配置项

IGetShareReq

字段	类型	必选	说明
share_id	string	是	共享id

字段	类型	必选	说明
result	IShareItem	是	返回结果