ListRecycledDirectoriesAndFiles - File Storage NAS - Alibaba Cloud Documentation Center

Queries deleted files or directories.

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:ListRecycledDirectoriesAndFiles	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.	1ca404****
FileId	string	Yes	The ID of the directory that you want to query. You can call the ListRecentlyRecycledDirectories operation to query the file ID.	04***08
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. If all the files and directories are incompletely returned in a query, the return value of the NextToken parameter is not empty. In this case, you can specify a valid value for the NextToken parameter to continue the query.	CJyNARIsMTY5OTI2NjQ3NTEzMjY2OTMwOF8xODA5NF8ufnl0YkROTl9uZXcuaXB5bmI=
MaxResults	long	No	The number of files or directories to return for each query. Valid values: 10 to 1000. Default value: 100.	100

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	98696EF0-1607-4E9D-B01D-F20930B6****
NextToken	string	A pagination token. If all the files and directories are incompletely returned in a query, the return value of the NextToken parameter is not empty. In this case, you can specify a valid value for the NextToken parameter to continue the query.	CKuO8QMSIjE2OTc3NzI0NjI5MTcyMTYyNDVfMzEzNTUyMF81MjEzODY=
Entries	array<object>	The information about files or directories in the recycle bin.
Entry	object
FileId	string	The IDs of the files or directories.	04***08
Type	string	The type of the returned object. Valid values: File Directory	File
Name	string	The name of the file or directory before it was deleted.	test001
DeleteTime	string	The time when the file or directory was deleted.	2021-05-30T10:08:08Z
Inode	string	The inode of the file or directory.	04***08
ATime	string	The time when the file or directory was last accessed.	2019-10-30T10:08:08Z
MTime	string	The time when the file or directory was last modified.	2019-10-30T10:08:08Z
CTime	string	The time when the metadata was last modified.	2019-10-30T10:08:08Z
Size	long	The size of the file. Unit: bytes. The value 0 is returned for this parameter if Directory is returned for the Type parameter.	1073741824

Examples

Sample success responses

JSONformat

{
  "RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****",
  "NextToken": "CKuO8QMSIjE2OTc3NzI0NjI5MTcyMTYyNDVfMzEzNTUyMF81MjEzODY=",
  "Entries": [
    {
      "FileId": "04***08",
      "Type": "File",
      "Name": "test001",
      "DeleteTime": "2021-05-30T10:08:08Z",
      "Inode": "04***08",
      "ATime": "2019-10-30T10:08:08Z",
      "MTime": "2019-10-30T10:08:08Z",
      "CTime": "2019-10-30T10:08:08Z",
      "Size": 1073741824
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalCharacters	The parameter contains illegal characters.	The parameter contains illegal characters.
400	MissingFileSystemId	FileSystemId is mandatory for this action.	-
400	InvalidParameter.KMSKeyId.KMSUnauthorized	KMS is not authorized.	KMS is not authorized.
400	InvalidParameter.KMSKeyId.CMKNotEnabled	The CMK needs to be enabled.	The CMK needs to be enabled.
404	InvalidFileSystem.NotFound	The specified file system does not exist.	The specified file system does not exist.
404	InvalidFileId.NotFound	The specified FileId(%FileId) does not exist.	The specified FileId (%FileId) does not exist.
404	InvalidParameter.InvalidNextToken	The specified NextToken is invaild.	-

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

Change history

Change time	Summary of changes	Operation
2024-09-05	The Error code has changed	View Change Details