列举压缩包目录
功能介绍
列举压缩包内文件目录。
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位) |
language |
否 |
String |
国际化语言标识,符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语,不传默认美式英语 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
containerId |
是 |
String |
空间id |
fileId |
是 |
String |
文件id |
pwd |
否 |
String |
压缩包加密明文 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
响应码 |
msg |
String |
响应消息 |
data |
data object |
列举压缩包目录响应数据 |
参数 |
参数类型 |
描述 |
---|---|---|
uncompressedFileList |
Array of UncompressedFileInfo objects |
压缩包内的文件信息列表,包括所有子文件和子目录。 同步时返回 |
taskId |
String |
任务ID,异步时返回 |
参数 |
参数类型 |
描述 |
---|---|---|
containerId |
String |
解压后的空间ID,注:仅解压文件后返回 |
fileId |
String |
解压后的文件ID,注:仅解压文件后返回 |
name |
String |
文件或文件夹在压缩包内全路径 |
fileSize |
Long |
文件大小,(单位B) |
type |
Integer |
请参考文件类型fileType的定义 1:内容 2:目录 |
updatedAt |
Long |
文件修改毫秒时间戳 |
subFileList |
Array of UncompressedFileInfo objects |
子文件和子目录列表(仅对于目录时展开) |
reason |
String |
失败原因(成功则空) |
code |
String |
错误码 |
reservatioinInfo |
Object |
预留字段 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:8 最大长度:36 |
error_msg |
String |
错误描述 最小长度:2 最大长度:512 |
请求示例
列举压缩包内文件目录。
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 |