查询与我有关的文件列表 - ListRelatedToMe

功能介绍

查询与我有关的文件列表。

授权信息

当前API调用无需身份策略权限。

URI

GET /koodrive/ose/v1/related

表1 Query参数
参数	是否必选	参数类型	描述
pageSize	否	Integer	每页返回的个数，默认是100，可接受值最大值是100。注意在到达最后的列表之前，实际有可能返回部分或者空结果
pageCursor	否	String	当前页游标，由前一个响应的nextCursor获取，默认为0
sortType	否	Integer	排序类型，1：相关操作时间（默认）
sortDirection	否	Integer	排序方向，1：升序，2：降序（默认）
displayName	否	String	支持按照展示名称模糊匹配
relatedType	否	String	相关类型 0：所有 1、分享给我的，空和0表示查所有类型
imageProcess	否	String	图片操作，可用于指定缩略图尺寸，具体取值参照https://support.huaweicloud.com/usermanual-obs/obs_01_0430.html
usage	否	String	文档、视频缩略图格式;取值范围minThumbnail,midThumbnail,largeThumbnail,superLargeThumbnail

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Traceid	否	String	业务跟踪id（必须58位）
Authorization	是	String	该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token}
language	否	String	国际化语言标识，符合i18n规范，如zh-CN表示简体中文，en-US表示美式英语，不传默认美式英语
X-User-Id	是	String	用户id，用于app鉴权
X-Date	是	String	日期，用于app鉴权
Host	是	String	地址，用于app鉴权

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
code	String	响应码
msg	String	响应信息
nextCursor	String	分页游标，如果不存在，代表已返回最后一个
relatedToMeInfos	Array of RelatedToMeRecord objects	分享链接列表
total	Long	总数

表4 RelatedToMeRecord
参数	参数类型	描述
operator	String	操作员名称
operateType	Integer	操作类型；1：分享
operateTime	String	操作时间
id	String	记录id，操作类型为分享则是分享id
displayName	String	展示名称
files	Array of FileInfo objects	文件列表
expireTime	String	失效时间
status	Integer	0：根据失效时间判断；1：文件已被删除，2：空间已失效（空间已禁用删除或者当前用户无空间权限）
operatorId	String	操作员id
containerId	String	空间id
tenantId	String	租户id

表5 FileInfo
参数	参数类型	描述
id	String	文件id
size	String	文件大小
fileType	String	文件类型
downloadLinks	Array of DownloadLink objects	图片类型需要，图片类型 fileType为15
recycled	Boolean	是否在回收站

表6 DownloadLink
参数	参数类型	描述
usage	String	用途默认：'content'-实体内容、'thumbnail'-缩略图,业务可以扩展该字段
downloadLink	String	附件下载地址

请求示例

查询与我有关的文件列表。

GET /koodrive/ose/v1/related?sortType=1&sortDirection=2&pageSize=2&pageCursor=&displayName=&relatedType=1

{
  "total" : 1,
  "relatedToMeInfos" : [ {
    "id" : "1427677119873431808",
    "operator" : "zujian1",
    "operatorId" : "1395664261493231745",
    "operateType" : 1,
    "operateTime" : "2024-05-23T11:39:35.000Z",
    "displayName" : "内容未审核.docx",
    "files" : [ {
      "id" : "Fv54zG8ha44HX2XRlrQlM76zD4KAN2uOB",
      "size" : 50383,
      "fileType" : "26",
      "recycled" : false,
      "downloadLinks" : [ {
        "usage" : "content",
        "downloadLink" : "https://b10-obs-ykj-uat-01.obs.cidc-rp-2006.joint.cmecloud.cn/6957916206ce4407ac9436567b14d719086?response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27%25E5%2586%2585%25E5%25AE%25B9%25E6%259C%25AA%25E5%25AE%25A1%25E6%25A0%25B8.docx&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240523T113937Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=MKRISPBZAJWFHNBJ5WLB%2F20240523%2Fcidc-rp-2006%2Fs3%2Faws4_request&X-Amz-Signature=e130a202a80157e63583bd7597452eb1d30a70c610db86be68717541114e2bd0"
      }, {
        "usage" : "thumbnail",
        "downloadLink" : "https://b10-obs-ykj-uat-01.obs.cidc-rp-2006.joint.cmecloud.cn/6957916206ce4407ac9436567b14d719086?x-image-process=image%2Fresize%2Cm_lfit%2Ch_128%2Cw_128&response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27%25E5%2586%2585%25E5%25AE%25B9%25E6%259C%25AA%25E5%25AE%25A1%25E6%25A0%25B8.docx&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240523T113937Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=MKRISPBZAJWFHNBJ5WLB%2F20240523%2Fcidc-rp-2006%2Fs3%2Faws4_request&X-Amz-Signature=e78515818612dbb024bf14300bd63bbb340e7f7476b988143089ce6d92d6d9f9"
      } ]
    } ],
    "expireTime" : "2024-05-30T11:39:35.000Z",
    "status" : 0,
    "containerId" : "IAAFfyRNd07vFgAAA1395504262720721025",
    "tenantId" : "d5ac574bd2934a69baa4f23c55daa8d4"
  } ],
  "code" : 0,
  "msg" : "成功"
}

响应示例

状态码：200

{
  "code" : "string",
  "msg" : "string",
  "nextCursor" : "string",
  "relatedToMeInfos" : [ {
    "operator" : "string",
    "operateType" : 0,
    "operateTime" : "2024-06-03T02:25:41.085Z",
    "id" : "string",
    "displayName" : "string",
    "files" : [ {
      "id" : "string",
      "size" : "string",
      "fileType" : "string",
      "downloadLinks" : [ {
        "usage" : "string",
        "downloadLink" : "string"
      } ],
      "recycled" : true
    } ],
    "expireTime" : "2024-06-03T02:25:41.085Z",
    "status" : 0,
    "operatorId" : "string",
    "containerId" : "string",
    "tenantId" : "string"
  } ],
  "total" : 0
}