更新时间:2026-02-03 GMT+08:00

统计文件夹 - StatsDir

功能介绍

统计文件夹下的目录数、文件数和文件总大小

授权信息

当前API调用无需身份策略权限。

URI

GET /koodrive/ose/v1/files/statsDir

表1 Query参数

参数

是否必选

参数类型

描述

fileId

String

参数解释:

目录id,支持传”root“统计根目录

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

containerId

String

参数解释:

目录归属的空间id

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

recursive

Boolean

参数解释:

是否递归统计文件;

递归则统计所有子目录、子文件;

不递归则仅统计指定目录下的直接子目录和子文件;

约束限制:

不支持只统计回收站的一级目录及文件;

取值范围:

true,false

默认取值:

默认为true

includeDirCount

Boolean

参数解释:

是否统计子目录总数

约束限制:

不涉及

取值范围:

true,false

默认取值:

true

includeFileCount

Boolean

参数解释:

是否统计子文件总数

约束限制:

不涉及

取值范围:

true,false

默认取值:

true

includeTotalSize

Boolean

参数解释:

是否统计文件总大小

约束限制:

不涉及

取值范围:

true,false

默认取值:

true

type

Integer

参数解释:

带筛选文件类型

约束限制:

不涉及

取值范围:

枚举值 1、普通文件;2、目录文件;不传或空时,统计所有类型

默认取值:

不涉及

extensions

String

参数解释:

待筛选文件扩展名列表,注意:文件扩展名不区分大小写,例如JPG和jpg搜索结果是一样的;

约束限制:

仅针对子文件有效;各扩展名之间用逗号分隔,例如"jpg,png",kooDrive支持的全量扩展名详见文档"使用前必读",最多支持100个扩展名后缀

取值范围:

不涉及

默认取值:

不涉及

categorys

String

参数解释:

待筛选文件分类列表

约束限制:

仅针对子文件有效;各分类元素之间用逗号分隔,例如"15,20",最多支持100个分类

取值范围:枚举值有10:文件夹、15:图片、 20:视频、 26:word、 27:excel、 28:ppt、 30:音频、 35:压缩文件、 40:应用、 45:其他

默认取值:

不涉及

hidden

Boolean

参数解释:

是否隐藏

约束限制:

不涉及

取值范围:

true:仅返回隐藏文件;false:仅返回非隐藏文件

默认取值:

是否隐藏,缺省返回全部文件

isRecycled

Boolean

参数解释:

是否统计回收站文件

约束限制:

不涉及

取值范围:

true表示仅统计跟随父目录删除的文件占用情况,如果此时fileId为root时,则会统计所有回收站文件;false表示不统计回收站,只统计正常文件;如果传null或者不传递时,当fileId为回收站目录时,统计的是跟随父目录删除的文件占用情况;当fileId为正常目录时,统计的是正常文件的占用情况;当fileId为root时,统计的是所有文件的占用情况;

默认取值:

默认为null

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

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’

约束限制:

距当前时间15分钟以内,不能晚于当前时间

取值范围:

不涉及

默认值:

不涉及

x-hw-share-folder-id

String

参数解释:

共享文件夹ID。如果传入了该请求头,则说明当前的操作是在共享文件夹内。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

Authorization

String

参数解释:

该字段存储的是Access Token。调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Access Token的获取请参考对应的开发手册

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

code

String

响应码

msg

String

响应信息

data

StatsData object

数据

表4 StatsData

参数

参数类型

描述

totalSize

String

文件总大小,单位:字节

subDirCount

String

子目录总数

subFileCount

String

子文件总数

extensionStatistics

Map<String,DirStatistics>

指定文件扩展名的统计结果,注意:仅当筛选条件extensionList非空时返回,DirStatistics中subDircount为空

categoryStatistics

Map<String,DirStatistics>

指定文件类别的统计结果,注意:仅当筛选条件categoryList非空时返回,DirStatistics中subDircount仅针对目录文件类别有效,totalSize、subFileCount仅针对普通文件类别有效

表5 DirStatistics

参数

参数类型

描述

totalSize

String

文件总大小

subDirCount

String

子目录总数

subFileCount

String

子文件总数

请求示例

查询目录FnNGsBnXUdIW7AycSK4ZCTIlPJ6JO1_sF下的目录数,文件数和文件总大小

POST /koodrive/ose/v1/files/statsDir?fileId=FnNGsBnXUdIW7AycSK4ZCTIlPJ6JO1_sF&containerId=IAAGvmhWei6Q7A4-A1557836058161393920&recursive=true

Authorization:Bearer+10f88*********4791e9ff

响应示例

状态码:200

搜索结果

{
  "code" : 0,
  "msg" : "success",
  "data" : {
    "totalSize" : 0,
    "subDirCount" : 1,
    "subFileCount" : 0
  }
}

状态码

状态码

描述

200

搜索结果