All Products
Search
Document Center

Apsara File Storage NAS:ListDirectoriesAndFiles

Last Updated:Feb 01, 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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

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 type of the files.

Default value: InfrequentAccess (IA).

InfrequentAccess
DirectoryOnlybooleanNo

Specifies whether to query only directories.

Valid values:

  • false (default): queries both directories and files
  • true: queries only directories
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****
Entriesobject []

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 medium.

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 medium.
  • false: The directory does not contain files stored in the IA storage medium.
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 type of the file.

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

Valid values:

  • InfrequentAccess: IA storage medium
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****

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****"
    }
  ]
}

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
2022-07-15The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404
Output ParametersThe response structure of the API has changed.