All Products
Search
Document Center

File Storage NAS:CancelRecycleBinJob

Last Updated:Dec 11, 2024

Cancels a running job of the recycle bin.

Operation description

  • Only General-purpose NAS file systems support this operation.
  • 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

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
nas:CancelRecycleBinJobupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
JobIdstringYes

The job ID.

rb-15****ed-r-1625****2441

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

98696EF0-1607-4E9D-B01D-F20930B6****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400IllegalCharactersThe parameter contains illegal characters.The parameter contains illegal characters.
400MissingJobIdJobId is mandatory for this action.JobId is mandatory for this action.
403OperationDenied.ConflictThe operation is in conflict with (% JobId). Please try again later.The operation is in conflict with (% JobId). Please try again later.
404InvalidJobId.NotFoundThe specified JobId(%JobId) does not exist.The specified JobId (%JobId) does not exist.

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

Change history

Change timeSummary of changesOperation
2024-09-05The Error code has changedView Change Details