Restores files from the recycle bin of a General-purpose NAS file system.
Description
- 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
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | CreateRecycleBinRestoreJob |
The operation that you want to perform. Set the value to CreateRecycleBinRestoreJob. |
FileSystemId | String | Yes | 1ca404**** |
The ID of the file system. |
FileId | String | Yes | 04***08 |
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. |
TargetFileId | String | Yes | 13***15 |
The ID of the directory to which the file is restored. |
ClientToken | String | No | 123e4567-e89b-12d3-a456-42665544**** |
The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it 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 the idempotence of a request. Note If you do not specify this parameter, the system automatically uses the request ID
as the client token. However, the IDs of different requests may be the same or different.
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 98696EF0-1607-4E9D-B01D-F20930B6**** |
The ID of the request. |
JobId | String | rb-10****491ff-r-162****165400 |
The ID of the job. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=CreateRecycleBinRestoreJob
&FileSystemId=1ca404****
&FileId=04***08
&TargetFileId=13***15
&ClientToken=123e4567-e89b-12d3-a456-42665544****
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateRecycleBinRestoreJobResponse>
<RequestId>98696EF0-1607-4E9D-B01D-F20930B6****</RequestId>
<JobId>8C****C54</JobId>
</CreateRecycleBinRestoreJobResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "98696EF0-1607-4E9D-B01D-F20930B6****",
"JobId" : "8C****C54"
}
Error codes
HttpCode | Error code | Error message | Required |
---|---|---|---|
400 | IllegalCharacters | The parameter contains illegal characters. | The error message returned because the specified value of a parameter is invalid. |
400 | MissingFileSystemId | FileSystemId is mandatory for this action. | The error message returned because the FileSystemId parameter is not specified. |
400 | MissingTargetFileId | TargetFileId is mandatory for this action. | The error message returned because the TargetFileId parameter is not specified. |
400 | MissingFileId | FileId is mandatory for this action. | The error message returned because the FileId parameter is not specified. |
400 | InvalidParameter.KMSKeyId.KMSUnauthorized | KMS is not authorized. | The error message returned because you are not authorized to access Key Management Service (KMS). |
400 | InvalidParameter.KMSKeyId.CMKNotEnabled | The CMK needs to be enabled. | The error message returned because the specified customer master key (CMK) is disabled. |
403 | OperationDenied.RecycleBinDisabled | The operation is denied because the recycle bin is disabled. | The error message returned because the request is not supported if the recycle bin feature is disabled. |
403 | OperationDenied.Conflict | The operation is in conflict with (% JobId). Please try again later. | The error message returned because the request is in conflict with another job. Please try again later. |
403 | OperationDenied.TooManyRunningJobs | The maximum number of running job is one. Please try again later. | The error message returned because you cannot run multiple jobs at the same time. Please try again later. |
403 | InvalidTargetFileId.NotDirectory | The specified TargetFileId(%TargetFileId) is not directory. | The error message returned because the value of the TargetFileId parameter does not specify a directory. |
404 | InvalidFileSystem.NotFound | The specified file system does not exist. | The error message returned because the specified file system does not exist. |
404 | InvalidFileId.NotFound | The specified FileId(%FileId) does not exist. | The error message returned because the specified file or directory does not exist. |
404 | InvalidTargetFileId.NotFound | The specified TargetFileId(%TargetFileId) does not exist. | The error message returned because the specified destination directory does not exist. |
For a list of error codes, visit the API Error Center.