文档

DescribeCdsFileShareLinks - 查询文件分享

更新时间:

查询文件分享。

调试

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

授权信息

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

请求参数

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

企业网盘 ID。

cn-hangzhou+cds-532033****
ShareIdstring

分享 ID。

7JQX1Fs****
Creatorsarray

分享的创建者列表。

string

分享的创建者。

alice
ShareNamestring

分享名称,支持模糊匹配。

user
Statusstring

分享状态。

枚举值:
  • disabled已取消
  • enabled有效
enabled
MaxResultsinteger

限定此次返回资源的数量,取值范围为 1~100。如果没有填写,则默认取值 100。 返回结果可以小于指定的数量,但不能多于指定的数量。

100
NextTokenstring

查询凭证(Token)。取值为上一次调用该接口返回的NextToken参数值,初次调用接口时无需设置该参数。

AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****

返回参数

名称类型描述示例值
object
Dataarray

数据信息。

CdsFileShareLinkModel

分享链接实体。

NextTokenstring

下一个查询开始的 Token,NextToken为空表示没有下一个。

AAAAAV3MpHK1AP0pfERHZN5pu6mnFXZiT7NdvGNgkInJ****
RequestIdstring

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
Successboolean

操作是否成功。

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

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

success
Messagestring

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

success

示例

正常返回示例

JSON格式

{
  "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****"
    }
  ],
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6mnFXZiT7NdvGNgkInJ****",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "Success": true,
  "Code": "success",
  "Message": "success"
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)
文档反馈