文档中心

快速入门

一分钟了解 XMagital 平台

开始制作您的第一个应用

应用的联调与自测

成为进阶开发者

解决方案

应用认证发布

标准规范

接口文档

应用开发示例

应用开发脚手架

文件目录管理接口

版本记录

版本号	日期	修改内容
v0.12.2	2024-08-30	修复已知问题

文件目录管理

新增目录

接口地址

/v1/directory/insert

请求方式

POST

请求数据类型

application/json

响应数据类型

application/json

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
req	新增文件目录	body	true	DirectoryReq	DirectoryReq
directoryPath	目录名称	body	true	string
userName	用户名称	body	true	string

请求示例

{
  "directoryPath": "oopSS",
  "userName": "admin"
}

响应参数

参数名称	参数说明	类型	schema
code	状态码	integer(int32)	integer(int32)
message	响应消息	string
timestamp	响应时间戳	integer(int64)	integer(int64)

响应示例

{
    "code": 0,
    "message": "新增成功",
    "timestamp": 1690250786865
}

查询目录

接口地址

/v1/directory/findAll

请求方式

POST

请求数据类型

application/json

响应数据类型

application/json

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
req	查询文件目录	body	true	DirectoryFindReq	DirectoryFindReq
userName	用户名称	body	true	string

请求示例

{
  "userName": "admin"
}

响应参数

参数名称	参数说明	类型	schema
code	状态码	integer(int32)	integer(int32)
message	响应消息	string
results	响应数据	array	DirectoryResp
absolutePath	目录觉得路径	string
createTime	创建时间	string(date-time)
directoryPath	目录名称	string
id	目录 id	string
updateTime	更新时间	string(date-time)
userName	用户	string
timestamp	响应时间戳	integer(int64)	integer(int64)

响应示例

示例如下

{
    "code": 0,
    "message": "查询成功",
    "data": [
        {
            "absolutePath": "/opt/deploy/glusterfs-file/oop/",
            "createTime": "2023-07-25 10:06:23",
            "directoryPath": "/oop/",
            "id": "ca3be3ba385946aa9ddf549e8682330d",
            "updateTime": "2023-07-25 10:06:23",
            "userName": "admin"
        },
        {
            "absolutePath": "/opt/deploy/glusterfs-file/oopSS/",
            "createTime": "2023-07-25 10:06:26",
            "directoryPath": "/oopSS/",
            "id": "f6c792940e9e4ce3a057fe1dbf54aac7",
            "updateTime": "2023-07-25 10:06:26",
            "userName": "admin"
        }
    ],
    "timestamp": 1690250789629
}

修改目录

接口地址

/v1/directory/update

请求方式

POST

请求数据类型

application/json

响应数据类型

application/json

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
directoryNewPath	新目录名称	body	true	string
directoryOldPath	旧目录名称	body	true	string
userName	用户名称	body	true	string

请求示例

{
  "directoryNewPath": "oopSS",
  "directoryOldPath": "oop01",
  "userName": "admin"
}

响应参数

参数名称	参数说明	类型	schema
code	状态码	integer(int32)	integer(int32)
message	响应消息	string
timestamp	响应时间戳	integer(int64)	integer(int64)

响应示例

{
    "code": 0,
    "message": "修改成功",
    "timestamp": 1690249800240
}

删除目录

接口地址

/v1/directory/delete

请求方式

POST

请求数据类型

application/json

响应数据类型

application/json

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
directoryPath	目录名称	body	true	string
userName	用户名称	body	true	string

请求示例

{
  "directoryPath": "oop",
  "userName": "admin"
}

响应参数

参数名称	参数说明	类型	schema
code	状态码	integer(int32)	integer(int32)
message	响应消息	string
timestamp	响应时间戳	integer(int64)	integer(int64)

响应示例

{
  "code": 0,
  "message": "删除成功",
  "timestamp": 1690250749100
}