ListRecycledDirectoriesAndFiles - Apsara File Storage NAS

Queries deleted files or directories.

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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 ListRecycleBinJobs operation to query the value of the FileId parameter.	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.	1256****25
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.
Entries	object []	The information about files or directories in the recycle bin.
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": "",
  "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.