搜索分享。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求语法
POST /v2/share_link/search
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
body | object | 否 | 请求体参数。 | |
limit | integer | 否 | 限定此次返回资源的数量,取值范围[1,100]。如果没有填写,默认取值100。 返回结果可以小于指定的数量,但不能多于指定的数量。 | 50 |
marker | string | 否 | 设定结果从marker之后按字母排序的第一个开始返回。如果不设定,则从头开始返回数据。
| NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg |
return_total_count | boolean | 否 | 是否返回搜到到的总记录数 | false |
order_by | string | 否 | 排序字段。 默认按照创建时间倒序排列。 枚举值如下:
| created_at |
order_direction | string | 否 | 排序方式。 如果是排序字段是created_at或者updated_at,则默认是倒序,其他排序字段默认是升序。 枚举值如下:
| ASC |
creators | array | 否 | 分享创建者(user_id) 1)如果不指定, 那么会根据用户本身的权限进行查询 1.1 网盘管理员/超管:所有成员 1.2 团队管理员:团队成员 1.3 普通用户:自身 2)如果指定, 那么只能指定那些有权限的成员, 参考1) | |
string | 否 | 分享创建者 | c9b7a5aa04d14ae3867fdc886fa01da4 | |
query | string | 否 | 查询条件 1)支持字段: 1.1 created_at 创建时间 1.2 updated_at 更新时间 1.3 share_name_for_fuzzy 分享名, 支持模糊匹配(match) 1.4 status 分享状态, 枚举值 enabled(分享中)/disabled(已取消) 1.5 expired_time 超时时间 永不过期:expired_time='1970-01-01T00:00:00', 返回的expiration="" expired_time<'1970-01-02T00:00:00'系统保留使用,不表示具体时间 | created_at>='2022-01-18T02:50:00' and created_at<'2022-01-19T09:45:28' and share_name_for_fuzzy match 'HD.mp4' and status in ['enabled', 'disabled'] and expired_time='1970-01-01T00:00:00' |
返回参数
示例
正常返回示例
JSON
格式
{
"items": [
{
"share_id": "",
"share_pwd": "",
"drive_id": "",
"file_id_list": [
""
],
"expiration": "",
"expired": true,
"created_at": "",
"updated_at": "",
"description": "",
"share_name": "",
"creator": "",
"status": "",
"preview_count": 0,
"save_count": 0,
"download_count": 0,
"report_count": 0,
"video_preview_count": 0,
"access_count": 0,
"disable_preview": true,
"disable_save": true,
"disable_download": true,
"preview_limit": 0,
"save_limit": 0,
"download_limit": 0,
"require_login": true,
"share_all_files": true,
"share_msg": ""
}
],
"next_marker": "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg",
"total_count": 101
}
错误码
访问错误中心查看更多错误码。