Creates a task to permanently delete files or directories staged in the recycle bin.
Operation description
Only General-purpose NAS file systems support this feature.
The recycle bin must be enabled.
Mount the file system over NFS or SMB by using an ECS instance in the same VPC, and then delete the target file in the mount directory to move it to the recycle bin.
When a directory is permanently deleted, its contents are recursively deleted.
You can run only one permanent deletion task at a time for a single file system. You cannot initiate a new restoration or cleanup task while a file or directory is being permanently deleted.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
nas:CreateRecycleBinDeleteJob |
delete |
*FileSystem
|
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 to be permanently deleted. You can call the ListRecycledDirectoriesAndFiles operation to query the ID of the deleted data. |
104 |
| ClientToken |
string |
No |
Ensures the idempotence of the request. You can generate the parameter value from your client. Make sure that the value is unique across different requests. The ClientToken parameter supports only ASCII characters and can be up to 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 ClientToken. The RequestId of each API request may be different. |
123e4567-e89b-12d3-a456-42665544**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The ID of the request. |
98696EF0-1607-4E9D-B01D-F20930B6**** |
| JobId |
string |
The ID of the task. |
8C****C54 |
Examples
Success response
JSON format
{
"RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****",
"JobId": "8C****C54"
}
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 | 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.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. |
| 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. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.