List File By Folder

查询指定目录下的文件列表

请求格式

GET http://{apigw-address}/dfs-api/v1.0/search/searchFolderByPage

请求参数(URI)

请求参数 (URI)
名称 位置 (Path/Query) 是否必须 数据类型 描述
tenant Query True String 租户名称
loginTenant Query True String 当前登录租户
filePath Query True String 文件所在路径
pages Query False Int 页号,默认值1表示第1页;如不在Query中声明该参数,则使用其默认值
pageSize Query False Int 每页大小,默认值10表示每页包含10条记录;如不在Query中声明该参数,则使用其默认值

注解

使用 pagespageSize 来约束返回结果的显示。例如,要显示第201-第300条记录,则应设置 pageSize=100 pages=3pageSize=100 会将记录按照每100条记录为一页划分好, pageToken=3 表示想要查询第3页,即第201至第300条记录。

响应参数

响应参数
名称 数据类型 描述
status Int 响应状态码
msg String 返回消息,用于描述响应结果
submsg String 返回子消息,用于描述响应结果
data Object 响应数据结构体,结构见下表
data对象结构
名称 数据类型 描述
pages Int 页号
pageSize Int 每页包含记录条数
totalSize Int 实际查询到的记录总条数
data Array 目标路径下的文件及文件夹对象构成的列表,其结构见下表
data列表的成员对象结构
名称 数据类型 描述
name String 文件名,包括了其扩展名
type String 文件类型,可以是 “file” 文件,或者 “folder” 文件夹

示例

请求示例

GET //{apigw-address}/dfs-api/v1.0/search/searchFolderByPage?tenant=EDGE&filePath=/path/&pages=1&pageSize=3&loginTenant=EDGE

返回示例

{
   "status":0,
   "msg":"success",
   "submsg":"",
   "data":{
      "pages":1,
      "pageSize":10,
      "totalSize":4,
      "data":[
         {
            "name":"test1.txt",
            "type":"file"
         },
         {
            "name":"test2.txt",
            "type":"file"
         },
         {
            "name":"/path",
            "type":"folder"
         },
         {
            "name":"/path2",
            "type":"folder"
         }
      ]
   }
}