文档首页/ 云空间服务 KooDrive/ API参考/ API/ 分享管理-分享给我/ 列举分享给我的文件列表
更新时间：2024-12-24 GMT+08:00
查看PDF
分享

列举分享给我的文件列表

功能介绍

列举分享给我的文件列表。

URI

GET /koodrive/ose/v1/share/received

表1 Query参数

参数

是否必选

参数类型

描述

pageSize

否

Integer

每页返回的个数，默认是100，可接受值最大值是100。注意在到达最后的列表之前，实际有可能返回部分或者空结果

pageCursor

否

String

当前页游标，由前一个响应的nextCursor获取，默认为0

sortType

否

Integer

排序类型，4：分享时间（默认）

sortDirection

否

Integer

排序方向，1：升序，2：降序（默认）

displayName

否

String

支持按照展示名称模糊匹配

imageProcess

否

String

图片操作，可用于指定缩略图尺寸，具体取值参照https://support.huaweicloud.com/usermanual-obs/obs_01_0430.html

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Authorization

是

String

该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token}

X-Traceid

否

String

业务跟踪id（必须58位）

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

code

Integer

响应码

msg

String

响应信息

nextCursor

String

分页游标，如果不存在，代表已返回最后一个

shareLinks

Array of ShareWithMeLink objects

分享链接列表
表4 ShareWithMeLink

参数

参数类型

描述

shareId

String

分享ID

shortUrl

String

分享短码

linkUrl

String

分享链接

shareTime

String

分享时间

ownerId

String

分享人id

ownerName

String

分享人姓名

displayName

String

展示名称

files

Array of ShareFileInfo objects

分享的文件列表

permission

SharePermission object

分享权限（后续支持）

expireTime

String

失效时间

status

Integer

分享状态，0：根据失效时间判断，1：文件已被删除，2：已失效

comment

String

分享留言

containerId

String

空间id

downloadCnt

Integer

下载次数

saveCnt

Integer

保存次数

scope

String

范围

updateTime

String

更新时间

viewCnt

String

浏览次数
表5 ShareFileInfo

参数

参数类型

描述

id

String

*文件id

fileName

String

*文件名，最长160个字节

fileType

String

文件类型，外部输入，最长250个字符

mimeType

String

*内容类型

size

Integer

文件大小

parentFolder

Array of strings

父目录ID列表，注意：当前只取第一个父母Id

fileSuffix

String

文件后缀，fullFileExtension最后一个字符串

containers

Array of strings

空间标识

downloadLinks

Array of downloadLinks objects

下载链接

recycled

Boolean

是否在回收站标识
表6 downloadLinks

参数

参数类型

描述

usage

String

用途默认：'content'-实体内容、'thumbnail'-缩略图,业务可以扩展该字段

downloadLink

String

下载链接
表7 SharePermission

参数

参数类型

描述

preview

Boolean

预览权限

edit

Boolean

编辑权限

download

Boolean

下载权限

请求示例

GET /koodrive/ose/v1/share/received?pageSize=&pageCursor=0&sortType=2&sortDirection=4&displayName=&tenantId=String

Authorization:Bearer+10f88*************5a544791e9ff

响应示例

状态码： 200

OK

{
  "code" : "string",
  "msg" : "string",
  "nextCursor" : "string",
  "shareLinks" : [ {
    "shareId" : "string",
    "shortUrl" : "string",
    "linkUrl" : "string",
    "shareTime" : "2024-06-03T02:02:00.797Z",
    "ownerId" : "string",
    "ownerName" : "string",
    "displayName" : "string",
    "files" : [ {
      "id" : "string",
      "fileName" : "string",
      "fileType" : "string",
      "mimeType" : "string",
      "size" : 0,
      "parentFolder" : [ "string" ],
      "fileSuffix" : "string",
      "containers" : [ "string" ]
    } ],
    "permission" : {
      "preview" : true,
      "edit" : true,
      "download" : true
    },
    "expireTime" : "2024-06-03T02:02:00.797Z",
    "status" : 0,
    "comment" : "string"
  } ]
}

状态码

状态码

描述

200

OK

相关文档