文档首页/ 云空间服务 KooDrive/ API参考/ API/ 分享管理-访问链接/ 列举分享文件 - listShareFiles
更新时间：2025-10-22 GMT+08:00
查看PDF
分享

列举分享文件 - listShareFiles

功能介绍

列举分享文件。

授权信息

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

URI

POST /koodrive/ose/v1/share/files

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Authorization

是

String

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

X-Traceid

否

String

业务跟踪id（必须58位）

X-User-Id

是

String

用户id，用于app鉴权

X-Date

是

String

日期，用于app鉴权

Host

是

String

地址，用于app鉴权
表2 请求Body参数

参数

是否必选

参数类型

描述

shortUrl

是

String

分享短码

parentFolder

否

String

父目录id

pageSize

否

Integer

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

pageCursor

否

String

当前页游标，由前一个响应的nextCursor获取

sortType

否

Integer

排序类型，1:文件名排序，2：文件大小排序，4：修改时间排序（默认）

sortDirection

否

Integer

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

kdstoken

否

String

分享临时token

refreshCount

否

Boolean

是否刷新计数

fileName

否

String

文件名

imageProcess

否

String

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

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

code

Integer

响应码

msg

String

响应信息

nextCursor

String

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

link

CommonShareLink object

访问链接公共信息

files

Array of ShareFile objects

分享文件列表
表4 CommonShareLink

参数

参数类型

描述

shareId

String

分享ID

shortUrl

String

分享短码

shareTime

String

分享时间

ownerId

String

分享人id

ownerName

String

分享人姓名

permission

SharePermission object

分享权限（后续支持）

expireTime

String

失效时间

status

Integer

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

expireDate

String

有效期
表5 SharePermission

参数

参数类型

描述

preview

Boolean

预览权限

edit

Boolean

编辑权限

download

Boolean

下载权限
表6 ShareFile

参数

参数类型

描述

id

String

*文件id

fileName

String

*文件名，最长250个字节

fileType

String

文件类型，外部输入

parentFolder

Array of strings

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

fileSuffix

String

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

size

Integer

文件大小

containers

Array of strings

空间标识

downloadLinks

Map<String,downloadLinks>

下载链接

editedTime

String

文件修改时间
表7 downloadLinks

参数

参数类型

描述

usage

String

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

downloadLink

String

下载链接

请求示例

POST /koodrive/ose/v1/share/files

{
  "shortUrl" : "string",
  "parentFolder" : "string",
  "pageSize" : 0,
  "pageCursor" : "string",
  "sortType" : 0,
  "sortDirection" : 0,
  "kdstoken" : "string",
  "refreshCount" : true,
  "fileName" : "string"
}

响应示例

状态码：200

OK

{
  "code" : "string",
  "msg" : "string",
  "nextCursor" : "string",
  "link" : {
    "shareId" : "string",
    "shortUrl" : "string",
    "shareTime" : "2024-06-03T02:23:40.607Z",
    "ownerId" : "string",
    "ownerName" : "string",
    "permission" : {
      "preview" : true,
      "edit" : true,
      "download" : true
    },
    "expireTime" : "2024-06-03T02:23:40.607Z",
    "expireDate" : "3",
    "status" : 0
  },
  "files" : [ {
    "id" : "string",
    "fileName" : "string",
    "fileType" : "string",
    "parentFolder" : [ "string" ],
    "fileSuffix" : "string",
    "size" : 0,
    "containers" : [ "string" ],
    "editedTime" : "2024-06-03T02:23:40.607Z"
  } ]
}

状态码

状态码

描述

200

OK

相关文档