ListDirectoriesAndFiles - 查询目录和文件列表

更新时间:
复制 MD 格式

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

接口说明

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

nas:ListDirectoriesAndFiles

get

*FileSystem

acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}

请求参数

名称

类型

必填

描述

示例值

FileSystemId

string

文件系统 ID。

31a8e4****

Path

string

指定目录的绝对路径。

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

/pathway/to/folder

NextToken

string

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

TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=

StorageType

string

分级存储类型。

  • InfrequentAccess:低频存储。

  • Archive:归档存储。

  • All:查询所有存储数据。

说明

当 StorageType 取值为 ALL 时,必须配置 DirectoryOnly 参数,且值为 true.

枚举值:

  • All :

    查询所有存储数据

  • Archive :

    归档存储

  • InfrequentAccess :

    低频存储

InfrequentAccess

DirectoryOnly

boolean

是否只查询目录。

取值:

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

  • true:是,只查询目录

说明

当 StorageType 取值为 All 时,DirectoryOnly 取值为 true,不能为 false。

false

MaxResults

integer

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

取值范围:10~128

默认值:100

100

返回参数

名称

类型

描述

示例值

object

NextToken

string

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

TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=

RequestId

string

请求 ID。

2D69A58F-345C-4FDE-88E4-BF518948****

Entries

array<object>

目录或文件信息集合。

object

目录或文件信息集合。

Type

string

返回结果的类型。

包括:

  • File:文件

  • Directory:目录

File

HasInfrequentAccessFile

boolean

是否包含低频存储文件。

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

包括:

  • true:包含

  • false:不包含

true

Ctime

string

元数据修改时间。

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

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

2021-02-11T10:08:10Z

Mtime

string

文件修改时间。

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

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

2021-02-11T10:08:08Z

Size

integer

文件的大小。

单位:Byte(字节)

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

1024

StorageType

string

返回文件的分级存储类型。

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

包括:

  • InfrequentAccess:低频存储。

  • Archive:归档存储。

InfrequentAccess

Atime

string

查询时间。

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

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

2021-02-01T10:08:08Z

Name

string

文件名或目录名。

file.txt

RetrieveTime

string

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

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

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

2021-02-11T10:08:08Z

Inode

string

文件或目录 inode。

66

FileId

string

目录或文件的 FileId。

66

Owner

string

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

37862c****

HasArchiveFile

string

是否包含归档存储文件。

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

包括:

  • true:包含

  • false:不包含

true

OfflineDuration

integer

转储为归档文件的总时长。单位:秒。

3600

OfflineUnchangedDuration

integer

转储为归档文件后文件距今未被改动的总时长。单位:秒。

3600

示例

正常返回示例

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****",
      "HasArchiveFile": "true",
      "OfflineDuration": 3600,
      "OfflineUnchangedDuration": 3600
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

400 OperationDenied.InvalidNextToken The specified NextToken is invalid. 指定的NextToken参数非法。
404 InvalidFileSystem.NotFound The specified file system does not exist. 指定的文件系统不存在。
404 InvalidParameter.PathNotExist The specified path does not exist. 指定的路径不存在。

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

变更历史

更多信息,参考变更详情