文档

CreateCdsFileShareLink - 创建文件分享

更新时间:

创建文件分享。

调试

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

授权信息

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

请求参数

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

企业网盘 ID。

cn-shanghai+cds-135515****
SharePwdstring

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

12345678
Expirationstring

失效时间点。 RFC3339 格式。 当取值为空时,表示永久有效。

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

分享描述。 长度范围为 0~1024 个字符。

SharedFile
ShareNamestring

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

view.txt
DisablePreviewboolean

是否禁止预览分享中的文件。

枚举值:
  • true禁止预览
  • false允许预览
false
DisableSaveboolean

是否禁止转存分享中的文件。

枚举值:
  • true禁止转存
  • false允许转存
false
DisableDownloadboolean

是否禁止下载分享中的文件。

枚举值:
  • true禁止下载
  • false允许下载
false
PreviewLimitlong

分享预览次数限制。取值范围为整数,取值为 0 时表示不限制。

100
SaveLimitlong

分享转存次数限制。取值范围为整数,取值为 0 时表示不限制。

100
DownloadLimitlong

分享下载次数限制。取值范围为整数,取值为 0 时表示不限制。

100
EndUserIdstring

使用网盘的用户 ID。

alice
FileIdsarray

文件 ID 列表。

string

文件的 ID。您可以调用 ListCdsFiles 接口查询对应文件的 ID。

[ "4221bf6e6ab43c255edc4463bf3a6f5f5d31****" ]
GroupIdstring

团队空间 ID。

cg-i1ruuudp92qpj****

返回参数

名称类型描述示例值
object
Codestring

执行结果。返回success表示成功,否则将返回错误信息。

success
Messagestring

错误信息。当 Code 为success时,不返回该参数。

success
DataCdsFileShareLinkModel

数据信息。

RequestIdstring

请求 ID。

51592A88-0F2C-55E6-AD2C-2AD9C10D****
Successboolean

操作是否成功。

枚举值:
  • true成功
  • false失败
true

示例

正常返回示例

JSON格式

{
  "Code": "success",
  "Message": "success",
  "Data": {
    "Description": "文件分享链接。",
    "SaveLimit": 100,
    "DownloadCount": 100,
    "Creator": "user01",
    "SaveCount": 100,
    "DisableSave": false,
    "SharePwd": "12345678",
    "DisablePreview": false,
    "AccessCount": 10000,
    "ShareId": "7JQX1Fs****",
    "DownloadLimit": 100,
    "Status": "disabled",
    "DriveId": "dri-g0877jp3hu1ox****",
    "ModifiyTime": "2021-09-04T04:30:36Z",
    "DisableDownload": false,
    "Expiration": "2020-06-28T11:33:00.000+08:00",
    "Expired": true,
    "PreviewCount": 0,
    "PreviewLimit": 100,
    "VideoPreviewCount": 0,
    "ReportCount": 0,
    "FileIds": "[\\\"63886f1fe2014d9a5a3348768dcc27dfc57ee103\\\"]",
    "ShareName": "view.txt",
    "CreateTime": "2021-09-04T03:30:36Z",
    "ShareLink": "https://stg109960.apps.aliyunpds.com/disk/s/7uLJanz****"
  },
  "RequestId": "51592A88-0F2C-55E6-AD2C-2AD9C10D****",
  "Success": true
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-08-29OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:GroupId
  • 本页导读 (0)
文档反馈