全部产品
Search
文档中心

文件存储 NAS:ListDirectoriesAndFiles - 查询目录和文件列表

更新时间:Jan 24, 2024

获取通用型NAS指定目录下的低频存储文件和包含低频存储文件的子目录列表。

接口说明

仅通用型 NAS 文件系统支持该功能。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
nas:ListDirectoriesAndFilesRead
  • FileSystem
    acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}

请求参数

名称类型必填描述示例值
FileSystemIdstring

文件系统 ID。

31a8e4****
Pathstring

指定目录的绝对路径。

必须以正斜线(/)开头,并且是挂载点中真实存在的路径。

/pathway/to/folder
NextTokenstring

当请求的返回结果被截断时,您可以使用 NextToken 再次发起请求,获取从当前截断位置之后的内容。

TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
StorageTypestring

文件存储类型。

取值(默认值):InfrequentAccess(低频介质存储)

InfrequentAccess
DirectoryOnlyboolean

是否只查询目录。

取值:

  • false(默认值):否,可以查询目录或文件
  • true:是,只查询目录
false
MaxResultslong

每次查询结果中包含的目录或文件的个数。

取值范围:10~128

默认值:100

100

返回参数

名称类型描述示例值
object
NextTokenstring

当请求的返回结果被截断时,您可以使用 NextToken 再次发起请求,获取从当前截断位置之后的内容。

TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
RequestIdstring

请求 ID。

2D69A58F-345C-4FDE-88E4-BF518948****
Entriesobject []

目录或文件信息集合。

Typestring

返回结果的类型。

包括:

  • File:文件
  • Directory:目录
File
HasInfrequentAccessFileboolean

是否包含低频存储文件。

仅当 Type 为 Directory 时,返回该值且有意义。

包括:

  • true:包含
  • false:不包含
true
Ctimestring

原数据修改时间。

执行 ISO8601 标准表示,返回格式:yyyy-MM-ddTHH:mm:ssZ

仅当 Type 为 File 时,返回该值且有意义。

2021-02-11T10:08:10Z
Mtimestring

文件修改时间。

执行 ISO8601 标准表示,返回格式:yyyy-MM-ddTHH:mm:ssZ

仅当 Type 为 File 时,返回该值且有意义。

2021-02-11T10:08:08Z
Sizelong

文件的大小。

单位:Byte(字节)

仅当 Type 为 File 时,返回该值且有意义。

1024
StorageTypestring

返回文件的数据存储类型。

仅当 Type 为 File 时,返回该值且有意义。

包括:

  • InfrequentAccess:低频介质存储。
InfrequentAccess
Atimestring

查询时间。

执行 ISO8601 标准表示,返回格式:yyyy-MM-ddTHH:mm:ssZ

仅当 Type 为 File 时,返回该值且有意义。

2021-02-01T10:08:08Z
Namestring

文件名或目录名。

file.txt
RetrieveTimestring

距现在最近一次数据取回任务执行的时间。

执行 ISO8601 标准表示,返回格式:yyyy-MM-ddTHH:mm:ssZ

仅当 Type 为 File 时,返回该值且有意义。

2021-02-11T10:08:08Z
Inodestring

文件或目录 inode。

66
FileIdstring

目录或文件的 FileId。

66
Ownerstring

便携账号 ID。 仅当 ProtocolType=SMB 且开启访问控制时,该返回值具有意义。

37862c****

示例

正常返回示例

JSON格式

{
  "NextToken": "TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=",
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****",
  "Entries": [
    {
      "Type": "File",
      "HasInfrequentAccessFile": true,
      "Ctime": "2021-02-11T10:08:10Z",
      "Mtime": "2021-02-11T10:08:08Z",
      "Size": 1024,
      "StorageType": "InfrequentAccess",
      "Atime": "2021-02-01T10:08:08Z",
      "Name": "file.txt",
      "RetrieveTime": "2021-02-11T10:08:08Z",
      "Inode": "66",
      "FileId": "66",
      "Owner": "37862c****"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400OperationDenied.InvalidNextTokenThe specified NextToken is invalid.指定的NextToken参数非法。
404InvalidFileSystem.NotFoundThe specified file system does not exist.指定的文件系统不存在。
404InvalidParameter.PathNotExistThe specified path does not exist.指定的路径不存在。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-07-15OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
出参OpenAPI 返回结构发生变更