全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

查询文件系统目录列表

最近更新时间:2025-10-14 12:45:48

1. 接口描述

本接口(DescribeSubDirList)用于查询文件系统或特定目录的子目录列表。

2. 请求方法

GET

3. 请求参数

请求参数包含公共请求参数和接口请求参数。其中,公共请求参数是每个接口都会用到的请求参数,具体参见公共参数及签名机制;接口请求参数是各个接口所特有的,具体参见下方说明:

  1. 请求头

名称

是否必须

Content-Type

application/json

Accept

application/json

  1. 请求体

名称

类型

是否必须

描述

FileSystemId

string

  • 指定文件系统支持2种方式,建议择一使用:

    • 通过文件系统ID(FileSystemId)。

    • 输入文件系统完整信息,文件系统信息,存储类型(StoreClass) + 存储池名称(ClusterName) + 文件系统名称(FileSystemName)同时必填。

StoreClass

string

存储类型 取值:KPFS-P-S01(性能Ⅰ型)。

ClusterName

string

存储池名称,

从控制台>文件系统详情>资源池获取。

FileSystemName

string

文件系统名称,名称最大长度63字节。

DirPath

string

目录完整路径,格式 dir/xxx 或 /dir/××× 或 dir/×××/或/dir/×××/

  • 文件系统传入:/

  • 目录传入路径:dir/xxx 或 /dir/××× 或 dir/×××/或/dir/×××/

  • 目录最大深度255层,根目录是第一层

SearchKey

string

SearchKey为目录名称,取值:name。

SearchValue

string

目录名称部分,支持模糊比对。比如子目录test123,可取值:test。

Start

number

开始位置。比如从第10条开始返回,可取值:10。

Limit

number

返回条数。默认值及最大值均为1000。

Action

string

该参数为公共参数,取值:DescribeSubDirList。

Version

string

该参数为公共参数,取值:2024-09-30。

4. 返回参数

名称

类型

描述

RequestId

string

唯一请求ID,每次请求都会返回。

Data

object[]

目录数据。

— Name

string

子目录名称。

— UpdateTime

Long

目录最后修改时间戳。

TotalCount

number

子目录总数。

RequestId

string

唯一请求ID,每次请求都会返回。

5. 示例

请求示例

http://kpfs.api.ksyun.com?FileSystemId=301c1d57a1b14aadbb34ffccbf25369e&DirPath=/&SearchKey=name&Action=DescribeSubDirList&Version=2024-09-30

返回示例

{
 "RequestId": "ea82d72e-0169-4970-8beb-92d3a10964d7",
  "Data": [
        {
            "Name": "dir1",
            "UpdateTime":1732204800 
        },
        {
            "Name": "dir2",
            "UpdateTime":1732204860
        }
    ],
  "TotalCount":2
}

文档导读
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈