文档

CreateShareLink - 创建分享

更新时间:

创建分享。

接口说明

分享又称之为文件分享,是一个文件视图容器,通过其可将用户空间中的一个或多个文件暴露给匿名用户访问,匿名用户在分享权限的约束下访问其中的文件。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST /v2/share_link/create

请求参数

名称类型必填描述示例值
bodyobject

请求体参数。

drive_idstring

空间 id

1
share_all_filesboolean

是否分享整个 drive 中的文件

true
file_id_listarray

分享父路径文件 id 列表。 父路径文件个数范围[1, 100]。 如果share_all_files=true,那么此字段无效,否则必须要填写

string

分享父路径文件 id

9520943DC264
user_idstring

用户 id

u123
share_pwdstring

提取码。 提取码长度范围[0, 64]字节 不设置或者设置为空表示无提取码,在获取分享令牌的时候也不用设置提取码参数。 要求使用 ASCII 可见字符。

abcF123x
expirationstring

失效时间点。 RFC3339 格式,比如:"2020-06-28T11:33:00.000+08:00"。 当 expiration 取值""时,表示永久有效

2020-06-28T11:33:00.000+08:00
descriptionstring

分享描述。 长度范围[0, 1024]字符

百家讲坛合集
share_namestring

分享名。 如果未设置,默认使用 file_id_list 中的第一个 id 对应的文件名。 长度范围[0, 128]字符

百家讲坛-1.MP4
disable_previewboolean

禁止预览分享中的文件

false
disable_saveboolean

禁止转存分享中的文件

false
disable_downloadboolean

禁止下载分享中的文件

false
preview_limitlong

分享预览次数限制。 次数要求>=0。 次数 0 表示不限制

100
save_limitlong

分享转存次数限制。 次数要求>=0。 次数 0 表示不限制

100
download_limitlong

分享下载次数限制。 次数要求>=0。 次数 0 表示不限制

100
creatableboolean

允许在分享中的文件夹中创建文件;creatable 为 true 时,需要同时传 creatable_file_id_list 参数

true
creatable_file_id_listarray

允许上传的文件夹 file id 列表

string

文件夹 file id

9520943DC264

返回参数

名称类型描述示例值
ShareLink

返回信息

示例

正常返回示例

JSON格式

{
  "share_id": "7JQX1FswpQ8",
  "share_pwd": "abcF123x",
  "drive_id": "1",
  "file_id_list": [
    "[\"xx\"]"
  ],
  "expiration": "2020-06-28T11:33:00.000+08:00",
  "expired": false,
  "created_at": "2019-08-20T06:51:27.292Z",
  "updated_at": "2019-08-20T06:51:27.292Z",
  "description": "videos",
  "share_name": "video-1.MP4",
  "creator": "c9b7a5aa04d14ae3867fdc886fa01da4",
  "status": "enabled",
  "preview_count": 10,
  "save_count": 2,
  "download_count": 5,
  "report_count": 0,
  "video_preview_count": 1,
  "access_count": 4,
  "disable_preview": false,
  "disable_save": false,
  "disable_download": false,
  "preview_limit": 100,
  "save_limit": 100,
  "download_limit": 100,
  "require_login": false,
  "share_all_files": true,
  "share_msg": "",
  "save_download_limit": 0
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-05-08API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用