All Products
Search
Document Center

File Storage NAS:ListRecycledDirectoriesAndFiles

Last Updated:Dec 11, 2024

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
nas:ListRecycledDirectoriesAndFilesget
*FileSystem
acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
FileSystemIdstringYes

The ID of the file system.

1ca404****
FileIdstringYes

The ID of the directory that you want to query.

You can call the ListRecentlyRecycledDirectories operation to query the file ID.

04***08
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.

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=
MaxResultslongNo

The number of files or directories to return for each query.

Valid values: 10 to 1000.

Default value: 100.

100

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

98696EF0-1607-4E9D-B01D-F20930B6****
NextTokenstring

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=
Entriesarray<object>

The information about files or directories in the recycle bin.

Entryobject
FileIdstring

The IDs of the files or directories.

04***08
Typestring

The type of the returned object. Valid values:

  • File
  • Directory
File
Namestring

The name of the file or directory before it was deleted.

test001
DeleteTimestring

The time when the file or directory was deleted.

2021-05-30T10:08:08Z
Inodestring

The inode of the file or directory.

04***08
ATimestring

The time when the file or directory was last accessed.

2019-10-30T10:08:08Z
MTimestring

The time when the file or directory was last modified.

2019-10-30T10:08:08Z
CTimestring

The time when the metadata was last modified.

2019-10-30T10:08:08Z
Sizelong

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 codeError codeError messageDescription
400IllegalCharactersThe parameter contains illegal characters.The parameter contains illegal characters.
400MissingFileSystemIdFileSystemId is mandatory for this action.-
400InvalidParameter.KMSKeyId.KMSUnauthorizedKMS is not authorized.KMS is not authorized.
400InvalidParameter.KMSKeyId.CMKNotEnabledThe CMK needs to be enabled.The CMK needs to be enabled.
404InvalidFileSystem.NotFoundThe specified file system does not exist.The specified file system does not exist.
404InvalidFileId.NotFoundThe specified FileId(%FileId) does not exist.The specified FileId (%FileId) does not exist.
404InvalidParameter.InvalidNextTokenThe specified NextToken is invaild.-

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

Change history

Change timeSummary of changesOperation
2024-09-05The Error code has changedView Change Details