查询与我有关的文件列表 - ListRelatedToMe
功能介绍
查询与我有关的文件列表。
授权信息
当前API调用无需身份策略权限。
URI
GET /koodrive/ose/v1/related
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| pageSize | 否 | Integer | 参数解释: 每页返回的个数。注意在到达最后的列表之前,实际有可能返回部分或者空结果。 约束限制: 不涉及 取值范围: 最小1,最大100 默认值: 100 |
| pageCursor | 否 | String | 参数解释: 当前页游标,由前一个响应的nextCursor获取 约束限制: 不涉及 取值范围: 不涉及 默认值: 不涉及 |
| sortType | 否 | Integer | 参数解释: 排序类型: 约束限制: 不涉及 取值范围: 不涉及 默认值: 1 |
| sortDirection | 否 | Integer | 参数解释: 排序方向,1:升序,2:降序 约束限制: 不涉及 取值范围: 不涉及 默认值: 2 |
| displayName | 否 | String | 参数解释: 展示名称,支持按照展示名称模糊匹配 约束限制: 不涉及 取值范围: 不涉及 默认值: 不涉及 |
| relatedType | 否 | String | 参数解释: 相关类型 约束限制: 不涉及 取值范围: 默认值: 0 |
| imageProcess | 否 | String | 参数解释: 图片操作,可用于指定缩略图尺寸,具体取值参照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 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Traceid | 否 | String | 参数解释: 业务跟踪id(必须58位) 约束限制: 不涉及 取值范围: 长度为58位 默认值: 不涉及 |
| Authorization | 是 | String | 参数解释: 该字段存储的是Access Token。调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Access Token的获取请参考对应的开发手册,格式参考:Bearer+{access_token} 约束限制: 不涉及 取值范围: 不涉及 默认值: 不涉及 |
| language | 否 | String | 参数解释: 国际化语言标识 约束限制: 符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语 取值范围: 不涉及 默认值: en-US |
| X-User-Id | 是 | String | 参数解释: KooDrive侧用户id,用于app鉴权 约束限制: 不涉及 取值范围: 不涉及 默认值: 不涉及 |
| X-Date | 是 | String | 参数解释: 日期,用于app鉴权,格式为yyyyMMdd‘T’HHmmss‘Z’ 约束限制: 距当前时间15分钟以内,不能晚于当前时间 取值范围: 不涉及 默认值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | String | 响应码 |
| msg | String | 响应信息 |
| nextCursor | String | 分页游标,如果不存在,代表已返回最后一个 |
| relatedToMeInfos | Array of RelatedToMeRecord objects | 分享链接列表 |
| total | Long | 总数 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 文件id |
| size | String | 文件大小 |
| fileType | String | 文件类型 |
| downloadLinks | Array of DownloadLink objects | 图片类型需要,图片类型fileType为15 |
| recycled | Boolean | 是否在回收站 |
请求示例
查询与我有关的文件列表。
GET /koodrive/ose/v1/related?sortType=1&sortDirection=2&pageSize=2&pageCursor=&displayName=&relatedType=1
响应示例
状态码:200
OK
{
"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
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |