跳到主要内容

获取文件树

常规

GET/file/tree

请求

名称类型必填描述
onlyDirstring<'true' | 'false'>仅返回目录数据即过滤掉文件,默认为 false
startTimestring文件与目录名称的开始日期时间过滤(目前仅应用于运行日志),格式固定为 yyyy-MM-dd HH:mm
endTimestring文件与目录名称的结束日期时间过滤(目前仅应用于运行日志),格式固定为 yyyy-MM-dd HH:mm

响应

名称类型描述
pathstring绝对路径
titlestring目录名称
namestring文件名称
typestring<'folder' | 'file'>文件类型
updated_atstring最后修改时间
created_atstring创建时间
childrenobject[]成员,即下级内容
含有 children 属性的对象为目录,应使用 title 字段获取目录名称
示例
[
{
"path": "/arcadia",
"title": "arcadia",
"type": "folder",
"updated_at": "2024-01-01 00:00:00",
"created_at": "2024-01-01 00:00:00",
"children": [
{
"path": "/arcadia/script",
"title": "script",
"type": "folder",
"updated_at": "2024-01-01 00:00:00",
"created_at": "2024-01-01 00:00:00",
"children": [
{
"path": "/arcadia/script/example.js",
"name": "example.js",
"type": "file",
"updated_at": "2024-01-01 00:00:00",
"created_at": "2024-01-01 00:00:00"
},
{
"path": "/arcadia/script/template.sh",
"name": "template.sh",
"type": "file",
"updated_at": "2024-01-01 00:00:00",
"created_at": "2024-01-01 00:00:00"
},
...
]
},
...
]
}
]
不包含 log 目录和一些不适合展示的文件目录

获取指定类型的文件树

GET/file/tree/:type

请求

名称类型必填描述
typestring<FileTreeType>获取类型,具体详见下方 FileTreeType,默认为 all 全部
onlyDirstring<'true' | 'false'>仅返回目录数据即过滤掉文件,默认为 false
startTimestring文件与目录名称开始日期时间过滤(目前仅应用于运行日志),格式固定为 yyyy-MM-dd HH:mm
endTimestring文件与目录名称结束日期时间过滤(目前仅应用于运行日志),格式固定为 yyyy-MM-dd HH:mm

FileTreeType

名称含义
all全部
arcadia/arcadia
src/arcadia/src
config/arcadia/config
sample/arcadia/src/sample
scripts/arcadia/scripts
shell/arcadia/src/shell
log/arcadia/log
repo/arcadia/repo
raw/arcadia/raw
config_bak/arcadia/config/bak

类型 arcadia 等价于 all,且均不包含 log 目录和一些不适合展示的文件目录
使用 arcadiaall 时与 常规 接口响应相同,即获取完整文件树

响应

参考上方接口响应