列举压缩包目录 - listFile
功能介绍
列举压缩包内文件目录。数据文件需要加载到新加坡节点进行处理。
授权信息
当前API调用无需身份策略权限。
URI
POST /koodrive/ose/v1/archive/listFile
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
Authorization | 是 | String | 参数解释: 该字段存储的是Access Token。调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Access Token的获取请参考对应的开发手册,格式参考:Bearer+{access_token} 约束限制: 不涉及 取值范围: 不涉及 默认值: 不涉及 |
X-Traceid | 否 | String | 参数解释: 业务跟踪id(必须58位) 约束限制: 不涉及 取值范围: 长度为58位 默认值: 不涉及 |
language | 否 | String | 参数解释: 国际化语言标识 约束限制: 符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语 取值范围: 符合i18n规范 默认取值: en-US |
X-User-Id | 是 | String | 参数解释: KooDrive侧用户id,用于app鉴权 约束限制: 不涉及 取值范围: 不涉及 默认值: 不涉及 |
X-Date | 是 | String | 参数解释: 日期,用于app鉴权 约束限制: 日期格式:yyyyMMDD'T'HHmmss'Z' ; 例如20251103T070140Z 取值范围: 距当前时间15分钟以内,不能晚于当前时间 默认值: 不涉及 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
containerId | 是 | String | 参数解释: 空间id 约束限制: 不涉及 取值范围: 不涉及 默认值: 不涉及 |
fileId | 是 | String | 参数解释: 文件id 约束限制: 不涉及 取值范围: 不涉及 默认值: 不涉及 |
pwd | 否 | String | 参数解释: 压缩包加密明文 如果压缩包有密码且未填写pwd,则列举压缩包文件将出错;没有密码的压缩包不填写不会报错 约束限制: 不涉及 取值范围: 不涉及 默认值: 不涉及 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
code | String | 响应码 |
msg | String | 响应消息 |
data | data object | 列举压缩包目录响应数据 |
参数 | 参数类型 | 描述 |
|---|---|---|
uncompressedFileList | UncompressedFileinfoList object | 压缩包内的文件信息列表,包括所有子文件和子目录。 同步时返回 |
progress | Integer | 任务进度,进度百分比的值 |
taskId | String | 任务ID,异步时返回 |
参数 | 参数类型 | 描述 |
|---|---|---|
code | String | 错误码 |
name | String | 文件名 |
type | String | 文件类型 1:内容 2:目录 |
updateAt | String | 文件修改时间戳,单位:毫秒(ms) |
fileSize | String | 文件或文件夹大小,单位:字节(Byte) |
状态码:400
参数 | 参数类型 | 描述 |
|---|---|---|
code | String | 错误码 |
msg | String | 错误描述 |
请求示例
列举压缩包内文件目录。
POST /ose/v1/archive/listFile
Authorization:Bearer+10f88**********4791e9ff
{
"containerId": "IAADfsBFCO6WtAtuAe3ab00aac61c45e18b0896269d5efb",
"fileId": "FvW8fIQFZmz6Fu-lZ-7pKt6wtJISsW0C-",
"pwd": " "
} 响应示例
状态码:200
列举压缩包目录响应数据
{
"data" : {
"taskId" : "1428103989525998336"
},
"code" : 0,
"msg" : "成功"
} 状态码
状态码 | 描述 |
|---|---|
200 | 列举压缩包目录响应数据 |
400 | Error response |

