Deletes a file or directory from the recycle bin.

Description

  • If you permanently delete a directory, the files in the directory are recursively cleared.
  • You can run only one job at a time for a single file system to permanently delete the files from the file system. You cannot create a restoration or deletion job when a file or directory is being deleted.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateRecycleBinDeleteJob

The operation that you want to perform.

Set the value to CreateRecycleBinDeleteJob.
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 permanently delete.

You can call the ListRecycledDirectoriesAndFiles operation to query the value of the FileId parameter.

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 make sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How do I ensure idempotence.

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 different.

Response parameters

Parameter Type Example Description
RequestId String 98696EF0-1607-4E9D-B01D-F20930B6****

The ID of the request.

JobId String 8C****C54

The ID of the job.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateRecycleBinDeleteJob
&FileSystemId=1ca404****
&FileId=04***08
&ClientToken=123e4567-e89b-12d3-a456-42665544****
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateRecycleBinDeleteJobResponse>
    <RequestId>98696EF0-1607-4E9D-B01D-F20930B6****</RequestId>
    <JobId>8C****C54</JobId>
</CreateRecycleBinDeleteJobResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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 error message returned because an invalid value is specified for a parameter.
400 MissingFileSystemId FileSystemId is mandatory for this action. The error message returned because the FileSystemId 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.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.
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.

For a list of error codes, visit the API Error Center.