All Products
Search
Document Center

File Storage NAS:ListDirectoriesAndFiles

Last Updated:Dec 06, 2024

Queries the infrequently-accessed files in a specified directory of a General-purpose NAS file system and the subdirectories that contain the files.

Operation description

Only General-purpose NAS file systems support this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
nas:ListDirectoriesAndFilesget
*FileSystem
acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
FileSystemIdstringYes

The ID of the file system.

31a8e4****
PathstringYes

The absolute path of the directory.

The path must start with a forward slash (/) and must be a path that exists in the mount target.

/pathway/to/folder
NextTokenstringNo

The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.

TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
StorageTypestringYes

The storage class.

  • InfrequentAccess: the Infrequent Access (IA) storage class.
  • Archive: the Archive storage class.
  • All: all stored data.
Note If you set the StorageType parameter to All, you must set the DirectoryOnly parameter to true.
InfrequentAccess
DirectoryOnlybooleanNo

Specifies whether to query only directories.

Valid values:

  • false (default): queries both directories and files.
  • true: queries only directories.
Note If you set the StorageType parameter to All, you must set the DirectoryOnly parameter to true.
false
MaxResultslongNo

The maximum number of directories or files to include in the results of each query.

Valid values: 10 to 128.

Default value: 100.

100

Response parameters

ParameterTypeDescriptionExample
object
NextTokenstring

A pagination token. It can be used in the next request to retrieve a new page of results.

TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
RequestIdstring

The request ID.

2D69A58F-345C-4FDE-88E4-BF518948****
Entriesarray<object>

The details about the files or directories.

Entryobject

The details about the files or directories.

Typestring

The type of the query result.

Valid values:

  • File
  • Directory
Directory
HasInfrequentAccessFileboolean

Indicates whether the directory contains files stored in the IA storage class.

This parameter is returned and valid only if the value of the Type parameter is Directory.

Valid values:

  • true: The directory contains files stored in the IA storage class.
  • false: The directory does not contain files stored in the IA storage class.
true
Ctimestring

The time when the raw data was modified.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.

This parameter is returned and valid only if the value of the Type parameter is File.

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

The time when the file was modified.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.

This parameter is returned and valid only if the value of the Type parameter is File.

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

The size of the file.

Unit: bytes.

This parameter is returned and valid only if the value of the Type parameter is File.

1024
StorageTypestring

The storage class.

This parameter is returned and valid only if the value of the Type parameter is File.

Valid values:

  • InfrequentAccess: the IA storage class.
  • Archive: the Archive storage class.
InfrequentAccess
Atimestring

The time when the file was queried.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.

This parameter is returned and valid only if the value of the Type parameter is File.

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

The name of the file or directory.

file.txt
RetrieveTimestring

The time when the last data retrieval task was run.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.

This parameter is returned and valid only if the value of the Type parameter is File.

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

The file or directory inode.

66
FileIdstring

The ID of the directory or file.

66
Ownerstring

The ID of the portable account. This parameter is returned and valid only if the value of the ProtocolType parameter is SMB and RAM-based access control is enabled.

37862c****
HasArchiveFilestring

Indicates whether the directory contains files stored in the Archive storage class.

This parameter is returned and valid only if the value of the Type parameter is Directory.

Valid values:

  • true: The directory contains files stored in the Archive storage class.
  • false: The directory does not contain files stored in the Archive storage class.
true

Examples

Sample success responses

JSONformat

{
  "NextToken": "TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=",
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****",
  "Entries": [
    {
      "Type": "Directory",
      "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"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400OperationDenied.InvalidNextTokenThe specified NextToken is invalid.The specified NextToken is invalid.
404InvalidFileSystem.NotFoundThe specified file system does not exist.The specified file system does not exist.
404InvalidParameter.PathNotExistThe specified path does not exist.The specified path does not exist.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-09-05API Description Update. The Error code has changedView Change Details
2024-03-25The Error code has changed. The response structure of the API has changedView Change Details
2022-07-15The Error code has changed. The response structure of the API has changedView Change Details