Use CreateRecycleBinRestoreJob to restore files from the recycle bin - File Storage NAS - Alibaba Cloud - File Storage NAS

Restores a file from the recycle bin.

Operation description

Only General-purpose NAS file systems support this feature.
A single file system can execute only one file restoration or cleanup task at a time. While a file is being restored, you cannot initiate a new file restoration or cleanup task.
A single restoration task can restore only one file or directory. Restoring a specified directory recursively restores all files in the directory.
After a file is restored, data reorganization is performed. Read request performance slightly decreases during data reorganization.

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

create

*FileSystem

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

None

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	The file system ID. Required. How to obtain: Call DescribeFileSystems to query the file system list and obtain the FileSystemId. Call CreateFileSystem to create a file system and obtain the FileSystemId from the response. Usage notes: This operation applies only to General-purpose NAS file systems. Before calling this operation, make sure that the recycle bin feature is enabled for the file system.	1ca404****
FileId	string	Yes	The FileId of the file or directory to restore. You can call the ListRecycledDirectoriesAndFiles operation to query the FileId of deleted data.	04***08
TargetFileId	string	Yes	The FileId of the directory to which the file is restored. You can call the ListRecentlyRecycledDirectories operation to query the TargetFileId of directories from which files have been deleted. You can call the ListDirectoriesAndFiles operation to query the TargetFileId of existing directories in the file system. Special notes: The FileId of the root directory of a file system is fixed to `2`. You can directly use this value as the TargetFileId to restore a file to the root directory without querying.	13***15
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Generate a value from your client to ensure that the value is unique among different requests. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence. Note If you do not specify ClientToken, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may vary for each API request.	123e4567-e89b-12d3-a456-42665544****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	98696EF0-1607-4E9D-B01D-F20930B6****
JobId	string	The task ID.	rb-10**491ff-r-162**165400

Examples

Success response

JSON format

{
  "RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****",
  "JobId": "rb-10****491ff-r-162****165400"
}

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	MissingTargetFileId	TargetFileId is mandatory for this action.	TargetFileId is mandatory for this action.
400	MissingFileId	FileId is mandatory for this action.	FileId 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.
403	OperationDenied.RecycleBinDisabled	The operation is denied because the recycle bin is disabled.	The operation is denied because the recycle bin is disabled.
403	OperationDenied.Conflict	The operation is in conflict with (% JobId). Please try again later.	The operation is in conflict with (% JobId). Please try again later.
403	OperationDenied.TooManyRunningJobs	The maximum number of running job is one. Please try again later.	The maximum number of running job is one. Please try again later.
403	InvalidTargetFileId.NotDirectory	The specified TargetFileId(% TargetFileId) is not directory.	The specified TargetFileId (% TargetFileId) is not directory.
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	InvalidTargetFileId.NotFound	The specified TargetFileId(%TargetFileId) does not exist.	The specified TargetFileId(%TargetFileId) does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.