链接复制成功!
列举我的分享 - listShareByMe
功能介绍
列举我分享的文件列表,一条分享记录一行,一次分享多个文件时展示名为第一个文件名+“等多个文件”,格式显示为folder,一次单个文件时显示该文件的信息。
授权信息
当前API调用无需身份策略权限。
URI
GET /koodrive/ose/v1/share
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| pageSize | 否 | Integer | 参数解释: 每页返回的个数。注意在到达最后的列表之前,实际有可能返回部分或者空结果。 约束限制: 不涉及 取值范围: 最小1,最大100 默认值: 100 |
| pageCursor | 否 | String | 参数解释: 当前页游标,由前一个响应的nextCursor获取 约束限制: 不涉及 取值范围: 不涉及 默认值: 不涉及 |
| sortType | 否 | Integer | 参数解释: 排序类型,4:分享创建时间 约束限制: 不涉及 取值范围: 4 默认值: 4 |
| sortDirection | 否 | Integer | 参数解释: 排序方向,1:升序,2:降序 约束限制: 不涉及 取值范围: 不涉及 默认值: 2 |
| displayName | 否 | String | 支持按照展示名称模糊匹配 参数解释:查询名称 约束限制:无 取值范围:无 默认取值:无 |
| imageProcess | 否 | String | 图片操作,可用于指定缩略图尺寸,具体取值参照https://support.huaweicloud.com/usermanual-obs/obs_01_0430.html 参数解释:缩略图尺寸 约束限制:无 取值范围:取值参照https://support.huaweicloud.com/usermanual-obs/obs_01_0430.html 默认取值:image/resize,m_lfit,h_128,w_128 |
| usage | 否 | String | 参数解释: 文档、视频缩略图格式 约束限制: 长度限制100 取值范围: minThumbnail,midThumbnail,largeThumbnail,superLargeThumbnail 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Authorization | 是 | String | 参数解释: 该字段存储的是Access Token。调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Access Token的获取请参考对应的开发手册,格式参考:Bearer+{access_token} 约束限制: 不涉及 取值范围: 不涉及 默认值: 不涉及 |
| X-Traceid | 否 | String | 参数解释: 业务跟踪id(必须58位) 约束限制: 不涉及 取值范围: 长度为58位 默认值: 不涉及 |
| X-User-Id | 是 | String | 参数解释: KooDrive侧用户id,用于app鉴权 约束限制: 不涉及 取值范围: 不涉及 默认值: 不涉及 |
| X-Date | 是 | String | 参数解释: 日期,用于app鉴权,格式为yyyyMMdd‘T’HHmmss‘Z’ 约束限制: 距当前时间15分钟以内,不能晚于当前时间 取值范围: 不涉及 默认值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | String | 响应码 |
| msg | String | 响应信息 |
| nextCursor | String | 分页游标,如果不存在,代表已返回最后一个 |
| shareLinks | Array of ShareByMeLink objects | 分享链接列表 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| shareId | String | 分享ID |
| shortUrl | String | 分享短码 |
| linkUrl | String | 分享链接 |
| shareTime | String | 分享时间 |
| scope | Integer | 分享范围,1:外链分享,3:指定企业用户访问 |
| files | Array of ShareFileInfo objects | 分享的文件列表 |
| displayName | String | 展示名称 |
| expireTime | String | 失效时间 |
| status | Integer | 分享状态,0:根据失效时间判断,1:文件已被删除,2:已失效,3:已过期 |
| comment | String | 分享留言 |
| viewCnt | Integer | 浏览次数 |
| downloadCnt | Integer | 下载次数 |
| saveCnt | Integer | 转存次数 |
| containerId | String | 分享文件所属空间id |
| containerName | String | 分享文件所属空间 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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 | 是否在回收站标识 |
请求示例
GET /koodrive/ose/v1/share?pageSize=&pageCursor=0&sortType=2&sortDirection=4&displayName= Authorization:Bearer+10f88*************5a544791e9ff
响应示例
状态码:200
OK
{
"shareLinks" : [ {
"shareId" : "1689759841444195840",
"shortUrl" : "1689759841452584448",
"linkUrl" : "https://kdconsole-test-gray.hwcloudtest.cn:8080/koodrive/ose/v1/share/public/download/redirect?shortUrl=1689759841452584448&agentName=standard&extractCode=BIqw8T1X",
"shareTime" : "2025-05-20T02:11:10.211Z",
"expireTime" : "2025-05-27T02:11:10.210Z",
"scope" : 1,
"files" : [ {
"recycled" : false,
"id" : "FgzdaJOvUdMXVGqP--cdF7ZRWEeIlVzPF",
"fileName" : "下载.webp",
"fileType" : "15",
"mimeType" : "image/webp",
"size" : 153326,
"parentFolder" : [ "DF2FLxs6DRwArootIAABh_RdhS8bOg0cA1684711052660690818" ],
"fileSuffix" : "webp",
"containers" : [ "IAABh_RdhS8bOg0cA1684711052660690818" ],
"downloadLinks" : [ {
"usage" : "content",
"downloadLink" : "https://obs-koodrive-test-2.obs.cn-north-4.myhuaweicloud.com/c06f30e6b4e64334b355eb7b8d10f101086?response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27%25E4%25B8%258B%25E8%25BD%25BD.webp&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20250520T021113Z&X-Amz-SignedHeaders=host&X-Amz-Expires=900&X-Amz-Credential=CKJ3TYZ9M7QPX4SXS5YC%2F20250520%2Fnorth-4%2Fs3%2Faws4_request&X-Amz-Signature=b28f386aff3385232224501ee808cef9772e8c403bdc5f38ac1ee4165f615350"
}, {
"usage" : "thumbnail",
"downloadLink" : "https://obs-koodrive-test-2.obs.cn-north-4.myhuaweicloud.com/c06f30e6b4e64334b355eb7b8d10f101086?x-image-process=image%2Fresize%2Cm_lfit%2Ch_128%2Cw_128&response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27%25E4%25B8%258B%25E8%25BD%25BD.webp&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20250520T021113Z&X-Amz-SignedHeaders=host&X-Amz-Expires=900&X-Amz-Credential=CKJ3TYZ9M7QPX4SXS5YC%2F20250520%2Fnorth-4%2Fs3%2Faws4_request&X-Amz-Signature=bcd6f6ae2479cdc39d33ccde3968cc5c36725992a6bc9fdf069cee7eaa03e811"
} ]
}, {
"recycled" : false,
"id" : "Fk63FCWhcDAga2puvYKRG1oTMjs-m30sI",
"fileName" : "圖片-1-1-1-75-750x422.png",
"fileType" : "15",
"mimeType" : "image/png",
"size" : 141587,
"parentFolder" : [ "DF2FLxs6DRwArootIAABh_RdhS8bOg0cA1684711052660690818" ],
"fileSuffix" : "png",
"containers" : [ "IAABh_RdhS8bOg0cA1684711052660690818" ],
"downloadLinks" : [ {
"usage" : "content",
"downloadLink" : "https://obs-koodrive-test-2.obs.cn-north-4.myhuaweicloud.com/d3f26272207047d1a12eafa4fcd99ed8086?response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27%25E5%259C%2596%25E7%2589%2587-1-1-1-75-750x422.png&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20250520T021113Z&X-Amz-SignedHeaders=host&X-Amz-Expires=900&X-Amz-Credential=CKJ3TYZ9M7QPX4SXS5YC%2F20250520%2Fnorth-4%2Fs3%2Faws4_request&X-Amz-Signature=c5ffcfd17ad3a0f19a7651ae33c883e3e01e5839087eb445bde42c3517e74d13"
}, {
"usage" : "thumbnail",
"downloadLink" : "https://obs-koodrive-test-2.obs.cn-north-4.myhuaweicloud.com/d3f26272207047d1a12eafa4fcd99ed8086?x-image-process=image%2Fresize%2Cm_lfit%2Ch_128%2Cw_128&response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27%25E5%259C%2596%25E7%2589%2587-1-1-1-75-750x422.png&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20250520T021113Z&X-Amz-SignedHeaders=host&X-Amz-Expires=900&X-Amz-Credential=CKJ3TYZ9M7QPX4SXS5YC%2F20250520%2Fnorth-4%2Fs3%2Faws4_request&X-Amz-Signature=0515fbd7808e509a3fe1018ee49127cdf0d45ec03bfc0de93e37cddfd3638aa2"
} ]
} ],
"displayName" : "下载.webp",
"status" : 0,
"comment" : "",
"containerName" : "个人空间",
"ownerType" : "1",
"containerId" : "IAABh_RdhS8bOg0cA1684711052660690818",
"viewCnt" : 0,
"downloadCnt" : 0,
"saveCnt" : 0,
"updateTime" : "2025-05-20T02:11:10.211Z"
} ],
"code" : 0,
"msg" : "Success."
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |