Use ListRecentlyRecycledDirectories to query recently deleted directories - File Storage NAS - Alibaba Cloud - File Storage NAS

Operation description

Only General-purpose NAS file systems support this feature.

Before you begin

Before calling this operation, make sure that the recycle bin feature is enabled for the file system. If the recycle bin is not enabled, this operation cannot return the list of recently deleted directories.

Enable the recycle bin

To enable the recycle bin feature, call the EnableRecycleBin operation. After the recycle bin is enabled, deleted directories in the file system are moved to the recycle bin. You can call this operation to query the list of recently deleted directories.

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:ListRecentlyRecycledDirectories

get

*FileSystem

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

None

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	The file system ID.	1ca404****
NextToken	string	No	The pagination token for the next page. You do not need to specify this parameter for the first request. If a single query does not return all directories, the NextToken parameter is returned with a value. You can specify a valid NextToken value in subsequent requests to continue the query.	1256****25
MaxResults	integer	No	The maximum number of directories to return 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.	9E15E394-38A6-457A-A62A-D9797C9A****
NextToken	string	The pagination token for the next page. If a single query does not return all directories, the NextToken parameter is returned with a value. You can specify a valid NextToken value in subsequent requests to continue the query.	1256****25
Entries	array<object>	The information about directories on which delete operations were recently performed.
	object
FileId	string	The directory ID.	04***08
Path	string	The absolute path of the directory.	/a/b
Name	string	The name of the directory.	b
LastDeleteTime	string	The time when the most recent delete operation was performed on the directory. The time follows the ISO 8601 standard in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.	2021-05-30T10:08:08Z

Examples

Success response

JSON format

{
  "RequestId": "9E15E394-38A6-457A-A62A-D9797C9A****",
  "NextToken": "1256****25",
  "Entries": [
    {
      "FileId": "04***08",
      "Path": "/a/b",
      "Name": "b",
      "LastDeleteTime": "2021-05-30T10:08:08Z"
    }
  ]
}

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	InvalidParameter.InvalidNextToken	The specified NextToken is invaild.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.