创建分享。
接口说明
分享又称之为文件分享，是一个文件视图容器，通过其可将用户空间中的一个或多个文件暴露给匿名用户访问，匿名用户在分享权限的约束下访问其中的文件。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求语法
POST /v2/share_link/create HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| body | object | 否 | 请求体参数。 | |
| drive_id | string | 是 | 空间 id | 1 |
| share_all_files | boolean | 否 | 是否分享整个 drive 中的文件 | |
| file_id_list | array | 否 | 分享父路径文件 id 列表。
父路径文件个数范围[1, 100]。
如果 | |
| string | 否 | 分享父路径文件 id | 9520943DC264 | |
| user_id | string | 否 | 用户 id。使用 AK 方式请求时，必填 | u123 |
| share_pwd | string | 否 | 提取码。 提取码长度范围[0, 64]字节 不设置或者设置为空表示无提取码，在获取分享令牌的时候也不用设置提取码参数。 要求使用 ASCII 可见字符。 | |
| expiration | string | 否 | 失效时间点。 RFC3339 格式，比如："2020-06-28T11:33:00.000+08:00"。 当 expiration 取值""时，表示永久有效 | 2020-06-28T11:33:00.000+08:00 |
| description | string | 否 | 分享描述。 长度范围[0, 1024]字符 | 百家讲坛合集 |
| share_name | string | 否 | 分享名。 如果未设置，默认使用 file_id_list 中的第一个 id 对应的文件名。 长度范围[0, 128]字符 | |
| disable_preview | boolean | 否 | 禁止预览分享中的文件 | false |
| disable_save | boolean | 否 | 禁止转存分享中的文件 | false |
| disable_download | boolean | 否 | 禁止下载分享中的文件 | false |
| preview_limit | long | 否 | 分享预览次数限制。 次数要求>=0。 次数 0 表示不限制 | 100 |
| save_limit | long | 否 | 分享转存次数限制。 次数要求>=0。 次数 0 表示不限制 | 100 |
| download_limit | long | 否 | 分享下载次数限制。 次数要求>=0。 次数 0 表示不限制 | 100 |
| office_editable | boolean | 否 | 允许在线编辑分享的文档 | true |
| creatable | boolean | 否 | 允许在分享中的文件夹中创建文件；creatable 为 true 时，需要同时传 creatable_file_id_list 参数 | true |
| creatable_file_id_list | array | 否 | 允许上传的文件夹 file id 列表 | |
| string | 否 | 文件夹 file id | 9520943DC264 |
返回参数
示例
正常返回示例
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": "pwd: 123",
"save_download_limit": 100,
"office_editable": true
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 查看变更详情 |