Cancels a running job of the recycle bin.

Description

  • You can cancel only jobs that are in the Running state. You cannot cancel jobs that are in the PartialSuccess, Success, Fail, or Cancelled state.
  • If you cancel a running job that permanently deletes files, you cannot restore the files that are already permanently deleted.
  • If you cancel a running job that restores files, you can query the restored files from the file system, and query the unrestored files from the recycle bin.

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 CancelRecycleBinJob

The operation that you want to perform.

Set the value to CancelRecycleBinJob.
JobId String Yes rb-15****ed-r-1625****2441

The ID of the job.

Response parameters

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

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CancelRecycleBinJob
&JobId=8C****C54
&Common request parameters

Sample responses

XML format 

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

<CancelRecycleBinJobResponse>
    <RequestId>98696EF0-1607-4E9D-B01D-F20930B6****</RequestId>
</CancelRecycleBinJobResponse>

JSON format 

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

{
  "RequestId" : "98696EF0-1607-4E9D-B01D-F20930B6****"
}

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 MissingJobId JobId is mandatory for this action. The error message returned because the JobId parameter is not specified.
403 OperationDenied.Conflict The operation is in conflict with (% JobId). Please try again later. The error message returned because the request conflicts with another job. Try again later.
404 InvalidJobId.NotFound The specified JobId(%JobId) does not exist. The error message returned because the ID of the specified job does not exist.

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