CreateRecycleBinRestoreJob - File Storage NAS - Alibaba Cloud Documentation Center

Restores a file or directory from the recycle bin.

Operation description

Usage notes

Only General-purpose NAS file systems support this operation.
You can run only one job at a time for a single file system to restore files to or clear files from the file system. You cannot create a restore or cleanup job when files are being restored from the recycle bin.
You can restore only one file or directory in a single restore job. If you restore a specified directory, all files in the directory are recursively restored.
After files are restored, the data of the files is defragmented. When the data is being defragmented, the read performance is slightly degraded.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
nas:CreateRecycleBinRestoreJob	create	*FileSystem `acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	The ID of the file system.	1ca404****
FileId	string	Yes	The ID of the file or directory that you want to restore. You can call the ListRecycleBinJobs operation to query the value of the FileId parameter.	04***08
TargetFileId	string	Yes	The ID of the directory to which the file is restored.	13***15
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token 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 this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.	123e4567-e89b-12d3-a456-42665544****

Response parameters

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

Examples

Sample success responses

JSONformat

{
  "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.	-
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 (%FileId) does not exist.
404	InvalidTargetFileId.NotFound	The specified TargetFileId(%TargetFileId) does not exist.	The specified TargetFileId(%TargetFileId) does not exist.

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

Change history

Change time	Summary of changes	Operation
2024-09-05	The Error code has changed	View Change Details