All Products
Search

This Product

    Apsara File Storage NAS:CreateRecycleBinDeleteJob

    Document Center

    Apsara File Storage NAS:CreateRecycleBinDeleteJob

    Last Updated:May 23, 2024

    Creates a job to permanently delete a file or directory from the recycle bin.

    Operation description

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

    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:CreateRecycleBinDeleteJobWrite
    • FileSystem
      acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    FileSystemIdstringYes

    The ID of the file system.

    		1ca404****
    FileIdstringYes

    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.

    		04***08
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request.

    You can use the client to generate the token, but you must make sure that the token 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 the idempotence?

    Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
    		123e4567-e89b-12d3-a456-42665544****

    Response parameters

    ParameterTypeDescriptionExample
    object

    Schema of Response

    RequestIdstring

    The request ID.

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

    The job ID.

    		8C****C54

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****",
  "JobId": "8C****C54"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400IllegalCharactersThe parameter contains illegal characters.The parameter contains illegal characters.
    400MissingFileSystemIdFileSystemId is mandatory for this action.-
    400MissingFileIdFileId is mandatory for this action.FileId is mandatory for this action.
    400InvalidParameter.KMSKeyId.KMSUnauthorizedKMS is not authorized.KMS is not authorized.
    400InvalidParameter.KMSKeyId.CMKNotEnabledThe CMK needs to be enabled.The CMK needs to be enabled.
    403OperationDenied.ConflictThe operation is in conflict with (% JobId). Please try again later.The operation is in conflict with (% JobId). Please try again later.
    403OperationDenied.TooManyRunningJobsThe maximum number of running job is one. Please try again later.The maximum number of running job is one. Please try again later.
    404InvalidFileSystem.NotFoundThe specified file system does not exist.The specified file system does not exist.
    404InvalidFileId.NotFoundThe specified FileId(%FileId) does not exist.The specified FileId (%FileId) does not exist.

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