功能介绍
列举我分享的文件列表,一条分享记录一行,一次分享多个文件时展示名为第一个文件名+“等多个文件”,格式显示为folder,一次单个文件时显示该文件的信息。
URI
GET /koodrive/ose/v1/share
表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 |
响应参数
状态码:200
表3 响应Body参数
|
参数 |
参数类型 |
描述 |
|
code |
String |
响应码 |
|
msg |
String |
响应信息 |
|
nextCursor |
String |
分页游标,如果不存在,代表已返回最后一个 |
|
shareLinks |
Array of ShareByMeLink objects |
分享链接列表 |
表4 ShareByMeLink
|
参数 |
参数类型 |
描述 |
|
shareId |
String |
分享ID |
|
shortUrl |
String |
分享短码 |
|
linkUrl |
String |
分享链接 |
|
shareTime |
String |
分享时间 |
|
scope |
Integer |
分享范围,1:外链分享(该功能目前只有白名单用户使用)2:仅企业内用户可访问,3:指定企业用户访问 |
|
files |
Array of ShareFileInfo objects |
分享的文件列表 |
|
displayName |
String |
展示名称 |
|
expireTime |
String |
失效时间 |
|
status |
Integer |
分享状态,0:根据失效时间判断,1:文件已被删除,2:已失效 |
|
comment |
String |
分享留言 |
|
viewCnt |
Integer |
浏览次数 |
|
downloadCnt |
Integer |
下载次数(后续支持) |
|
saveCnt |
Integer |
转存次数(后续支持) |
|
containerId |
String |
分享文件所属空间id |
|
containerName |
String |
分享文件所属空间 |
表5 ShareFileInfo
|
参数 |
参数类型 |
描述 |
|
id |
String |
*文件id |
|
fileName |
String |
*文件名,最长250个字节 |
|
fileType |
String |
文件类型 |
|
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 |
下载链接 |
请求示例
GET /koodrive/ose/v1/share?pageSize=&pageCursor=0&sortType=2&sortDirection=4&displayName=
Authorization:Bearer+10f88*************5a544791e9ff
响应示例
状态码:200
OK
{
"code" : "string",
"msg" : "string",
"nextCursor" : "string",
"shareLinks" : [ {
"shareId" : "string",
"shortUrl" : "string",
"linkUrl" : "string",
"shareTime" : "2024-06-03T01:58:35.419Z",
"scope" : 0,
"files" : [ {
"id" : "string",
"fileName" : "string",
"fileType" : "string",
"mimeType" : "string",
"size" : 0,
"parentFolder" : [ "string" ],
"fileSuffix" : "string",
"containers" : [ "string" ]
} ],
"displayName" : "string",
"permission" : {
"preview" : true,
"edit" : true,
"download" : true
},
"extractCode" : "string",
"expireTime" : "2024-06-03T01:58:35.419Z",
"status" : 0,
"comment" : "string",
"viewCnt" : 0,
"downloadCnt" : 0,
"saveCnt" : 0,
"containerId" : "string",
"containerName" : "string"
} ]
}