文档

ListShareLink - 列举分享

更新时间:

列举分享。

接口说明

Deprecated, 请使用分享 SearchShareLink 代替此接口。

调试

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

授权信息

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

请求语法

POST /v2/share_link/list HTTP/1.1

请求参数

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

请求体参数。

creatorstring

创建者

c9b7a5aa04d14ae3867fdc886fa01da4
limitinteger

限定此次返回资源的数量,取值范围[0,100]。

返回结果可以小于指定的数量,但不能多于指定的数量。

50
markerstring

设定结果从 marker 之后按字母排序的第一个开始返回。如果不设定,则从头开始返回数据。
默认值:无

NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg
order_bystring

排序字段。 默认按照创建时间倒序排列。 枚举值如下:

  • share_name(分享名称)
  • updated_at(分享修改时间)
  • description(分享描述)
  • created_at(分享创建时间)
share_name
order_directionstring

排序方式。 如果是排序字段是 created_at 或者 updated_at,则默认是倒序,其他排序字段默认是升序。 枚举值如下:

  • ASC(升序)
  • DESC(降序)
ASC
include_cancelledboolean

是否包含已取消的分享

true

返回参数

名称类型描述示例值
object

Schema of Response

itemsarray

结果对象。

ShareLink

分享信息

next_markerstring

下一页起始资源标识符, 最后一页该值为空。

NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg

示例

正常返回示例

JSON格式

{
  "items": [
    {
      "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
    }
  ],
  "next_marker": "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg"
}

错误码

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