Use ListRecycledDirectoriesAndFiles to query deleted files and directories - File Storage NAS - Alibaba Cloud - File Storage NAS

Queries deleted files or directories.

Operation description

Only General-purpose NAS file systems support this feature.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

nas:ListRecycledDirectoriesAndFiles

get

*FileSystem

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

None

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	The file system ID.	1ca404****
FileId	string	Yes	The FileId of the directory to query. This field is the NFS inode number. When the recycle bin is empty, you can call this operation with FileId=2 (root directory inode) to verify the reachability of the operation or query the recycle bin content under the root directory. Other valid FileId values can be obtained by calling the ListRecentlyRecycledDirectories operation.	04***08
NextToken	string	No	The pagination token for the next page. You do not need to specify this parameter for the first query. If a single query does not return all files and directories, a non-empty NextToken is returned. You can pass the correct NextToken in subsequent queries to continue retrieving results.	1256****25
MaxResults	integer	No	The number of files or directories returned per query. Valid values: 10 to 1000. Default value: 100.	100

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	98696EF0-1607-4E9D-B01D-F20930B6****
NextToken	string	The pagination token for the next page. If a single query does not return all files and directories, a non-empty NextToken is returned. You can pass the correct NextToken in subsequent queries to continue retrieving results.	None
Entries	array<object>	The collection of files or directories in the recycle bin.
	object
FileId	string	The FileId of the file or directory.	04***08
Type	string	The object type. Valid values: File: file Directory: folder	File
Name	string	The name of the file or directory before deletion.	test001
DeleteTime	string	The time when the file or directory was deleted. The time follows the ISO 8601 standard in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.	2021-05-30T10:08:08Z
Inode	string	The inode of the file or directory.	04***08
ATime	string	The most recent access time. The time follows the ISO 8601 standard in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.	2019-10-30T10:08:08Z
MTime	string	The most recent modification time. The time follows the ISO 8601 standard in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.	2019-10-30T10:08:08Z
CTime	string	The most recent metadata modification time. The time follows the ISO 8601 standard in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.	2019-10-30T10:08:08Z
Size	integer	The file size. Unit: bytes. When Type is set to Directory, the value 0 is returned.	1073741824

Examples

Success response

JSON format

{
  "RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****",
  "NextToken": "None",
  "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.	The FileSystemId parameter is not specified.
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 does not exist.
404	InvalidParameter.InvalidNextToken	The specified NextToken is invaild.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.