链接复制成功!
列举分享文件 - listShareFilesPublic
功能介绍
列举分享文件(该功能目前只有白名单用户使用)
授权信息
当前API调用无需身份策略权限。
URI
POST /koodrive/ose/v1/share/public/files
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Traceid | 否 | String | 参数解释: 业务跟踪id(必须58位) 约束限制: 不涉及 取值范围: 长度为58位 默认值: 不涉及 |
| language | 否 | String | 参数解释: 国际化语言标识 约束限制: 符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语 取值范围: 不涉及 默认值: en-US |
| X-Hw-Agentname | 是 | String | 参数解释: 运营商名称 约束限制: 不涉及 取值范围: 不涉及 默认值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| shortUrl | 是 | String | 参数解释: 分享短码 约束限制: 不涉及 取值范围: 不涉及 默认值: 不涉及 |
| parentFolder | 否 | String | 参数解释: 父目录的文件ID 约束限制: 不涉及 取值范围: 不涉及 默认值: 不涉及 |
| pageSize | 否 | Integer | 参数解释: 每页返回的个数。注意在到达最后的列表之前,实际有可能返回部分或者空结果。 约束限制: 不涉及 取值范围: 最小1,最大100 默认值: 100 |
| pageCursor | 否 | String | 参数解释: 当前页游标,由前一个响应的nextCursor获取 约束限制: 不涉及 取值范围: 不涉及 默认值: 不涉及 |
| sortType | 否 | Integer | 参数解释: 排序类型: 约束限制: 不涉及 取值范围: 1:文件名排序 2:文件大小排序 4:修改时间排序 默认值: 4 |
| sortDirection | 否 | Integer | 参数解释: 排序方向,1:升序,2:降序 约束限制: 不涉及 取值范围: 不涉及 默认值: 2 |
| kdstoken | 否 | String | 参数解释: 分享临时token 约束限制: 不涉及 取值范围: 不涉及 默认值: 不涉及 |
| refreshCount | 否 | Boolean | 参数解释: 是否刷新计数 约束限制: 不涉及 取值范围: 不涉及 默认值: 不涉及 |
| fileName | 否 | String | 参数解释: 文件名 约束限制: 不涉及 取值范围: 不涉及 默认值: 不涉及 |
| imageProcess | 否 | String | 参数解释: 图片缩略图大小,样例:image/resize,m_lfit,h_128,w_128 约束限制: 最多只能传5组,"image/resize,m_lfit,h_1080,w_1080;image/resize,m_lfit,h_128,w_128",此样例是2组 取值范围: 不涉及 默认值: image/resize,m_lfit,h_128,w_128 |
| usage | 否 | String | 参数解释: 文档、视频缩略图格式 约束限制: 长度限制100 取值范围: minThumbnail,midThumbnail,largeThumbnail,superLargeThumbnail 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | Integer | 响应码 |
| msg | String | 响应信息 |
| nextCursor | String | 分页游标,如果不存在,代表已返回最后一个 |
| link | CommonShareLink object | 访问链接公共信息 |
| files | Array of ShareFile objects | 分享文件列表 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| shareId | String | 分享ID |
| shortUrl | String | 分享短码 |
| shareTime | String | 分享时间 |
| ownerId | String | 分享人id |
| ownerName | String | 分享人姓名 |
| expireTime | String | 失效时间 |
| status | Integer | 分享状态,0:根据失效时间判断,1:文件已被删除,2:已失效,3:已过期 |
| expireDate | String | 有效期 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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 | 文件修改时间 |
请求示例
/koodrive/ose/v1/share/public/files
{
"shortUrl" : "1808628918203192832",
"parentFolder" : "",
"pageSize" : 100,
"pageCursor" : "",
"sortType" : "4",
"sortDirection" : "2",
"refreshCount" : false,
"kdstoken" : ""
} 响应示例
状态码:200
OK
{
"link" : {
"shareId" : "15929**********1824",
"shortUrl" : "1592**********1825",
"shareTime" : "2025-01-06T11:42:37.037Z",
"ownerId" : "1592**********54689",
"ownerName" : "",
"expireTime" : "2025-01-18T11:58:00.000Z",
"expireDate" : "11",
"status" : 0
},
"files" : [ {
"id" : "FnpODb**********Jw-KX6fZi",
"fileName" : "fileName",
"fileSuffix" : "",
"size" : 106437,
"parentFolder" : [ "DFdpAjykCN**********I8pAjaA1592924124240415488" ],
"containers" : [ "IAAEDB**********24240415488" ],
"fileType" : "15",
"downloadLinks" : [ {
"usage" : "content",
"downloadLink" : "https://obs-koodrive.obs.cn-north-4.myhuaweicloud.com/********************?response-content-disposition********************e535458df2e3a90bfa788"
}, {
"usage" : "thumbnail",
"downloadLink" : "https://obs-koodrive.obs.cn-north-4.myhuaweicloud.com/********************?response-content-disposition********************e535458df2e3a90bfa788"
} ],
"editedTime" : "2025-01-06T11:41:58.806Z"
}, {
"id" : "Fh0x**********GJ5KWFrqSc5Cp",
"fileName" : "590x400.jfif",
"fileSuffix" : "jfif",
"size" : 106437,
"parentFolder" : [ "DFdp********************2924124240415488" ],
"containers" : [ "IAAEDB**********40415488" ],
"fileType" : "15",
"downloadLinks" : [ {
"usage" : "content",
"downloadLink" : "https://obs-koodrive.obs.cn-north-4.myhuaweicloud.com/********************?response-content-disposition********************e535458df2e3a90bfa788"
}, {
"usage" : "thumbnail",
"downloadLink" : "https://obs-koodrive.obs.cn-north-4.myhuaweicloud.com/********************?response-content-disposition********************e535458df2e3a90bfa788"
} ],
"editedTime" : "2025-01-06T11:41:10.790Z"
} ],
"code" : 0,
"msg" : "成功"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |