ListDirectoriesAndFiles - File Storage NAS - Alibaba Cloud Documentation Center

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
nas:ListDirectoriesAndFiles	get	*FileSystem `acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	The ID of the file system.	31a8e4****
Path	string	Yes	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
NextToken	string	No	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=
StorageType	string	Yes	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
DirectoryOnly	boolean	No	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
MaxResults	long	No	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

Parameter	Type	Description	Example
	object
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results.	TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
RequestId	string	The request ID.	2D69A58F-345C-4FDE-88E4-BF518948****
Entries	array<object>	The details about the files or directories.
Entry	object	The details about the files or directories.
Type	string	The type of the query result. Valid values: File Directory	Directory
HasInfrequentAccessFile	boolean	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
Ctime	string	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
Mtime	string	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
Size	long	The size of the file. Unit: bytes. This parameter is returned and valid only if the value of the Type parameter is File.	1024
StorageType	string	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
Atime	string	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
Name	string	The name of the file or directory.	file.txt
RetrieveTime	string	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
Inode	string	The file or directory inode.	66
FileId	string	The ID of the directory or file.	66
Owner	string	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****
HasArchiveFile	string	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 code	Error code	Error message	Description
400	OperationDenied.InvalidNextToken	The specified NextToken is invalid.	The specified NextToken is invalid.
404	InvalidFileSystem.NotFound	The specified file system does not exist.	The specified file system does not exist.
404	InvalidParameter.PathNotExist	The 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 time	Summary of changes	Operation
2024-09-05	API Description Update. The Error code has changed	View Change Details
2024-03-25	The Error code has changed. The response structure of the API has changed	View Change Details
2022-07-15	The Error code has changed. The response structure of the API has changed	View Change Details