Queries the jobs of the recycle bin.

Description

You can query a maximum of 50 jobs that are recently executed.

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 ListRecycleBinJobs

The operation that you want to perform.

Set the value to ListRecycleBinJobs.
FileSystemId String Yes 1ca404****

The ID of the file system.

JobId String No rb-15****ed-r-1625****2441

The ID of the job.

PageSize Long No 10

The number of entries to return on each page.

Valid values: 1 to 100.

Default value: 10.
PageNumber Long No 1

The number of the page to return.

Pages start from page 1. Default value: 1.
Status String No All

The status of the job. Valid values:

  • Running: The job is running.
  • Defragmenting: The job is defragmenting data.
  • PartialSuccess: The job is partially completed.
  • Success: The job is completed.
  • Failed: The job failed.
  • Cancelled: The job is canceled.
  • All: all.

Response parameters

Parameter Type Example Description
RequestId String 9E15E394-38A6-457A-A62A-D9797C9A****

The ID of the request.

TotalCount Long 1

The number of jobs of the recycle bin.

PageNumber Long 1

The page number of the returned page.

PageSize Long 10

The number of jobs returned per page.

Jobs Array of Job

The array of information about the jobs of the recycle bin.

Id String 8C****C54

The ID of the job.

Type String Restore

The type of the job. Valid values:

  • Restore: a file restoration job
  • Delete: a file deletion job
FileId String 04***08

The ID of the file or directory in the job.

Status String Running

The status of the job. Valid values:

  • Running: The job is running.
  • Defragmenting: The job is defragmenting data.
  • PartialSuccess: The job is partially completed.
  • Success: The job is completed.
  • Failed: The job failed.
  • Cancelled: The job is canceled.
ErrorCode String None

The error code.

A valid value is returned only if you set the Status parameter to Fail or PartialSuccess.

Progress String 100

The progress of the job.

Valid values: 1 to 100
CreateTime String 2021-05-30T10:08:08Z

The time when the job was created.

FileName String test001

The name of the file or directory that is associated with the job.

ErrorMessage String None

The error message.

A valid value is returned only if you set the Status parameter to Fail or PartialSuccess.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListRecycleBinJobs
&FileSystemId=1ca404****
&JobId=rb-15****ed-r-1625****2441
&PageSize=10
&PageNumber=1
&Status=All
&<Common request parameters>

Sample success responses

XML format 

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

<ListRecycleBinJobsResponse>
    <RequestId>9E15E394-38A6-457A-A62A-D9797C9A****</RequestId>
    <TotalCount>1</TotalCount>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <Jobs>
        <Id>8C****C54</Id>
        <Type>Restore</Type>
        <FileId>04***08</FileId>
        <Status>Running</Status>
        <ErrorCode>None</ErrorCode>
        <Progress>100</Progress>
        <CreateTime>2021-05-30T10:08:08Z</CreateTime>
        <FileName>test001</FileName>
        <ErrorMessage>None</ErrorMessage>
    </Jobs>
</ListRecycleBinJobsResponse>

JSON format 

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

{
  "RequestId" : "9E15E394-38A6-457A-A62A-D9797C9A****",
  "TotalCount" : 1,
  "PageNumber" : 1,
  "PageSize" : 10,
  "Jobs" : {
    "Id" : "8C****C54",
    "Type" : "Restore",
    "FileId" : "04***08",
    "Status" : "Running",
    "ErrorCode" : "None",
    "Progress" : 100,
    "CreateTime" : "2021-05-30T10:08:08Z",
    "FileName" : "test001",
    "ErrorMessage" : "None"
  }
}

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 InvalidStatus Specified parameter Status is not valid. The error message returned because the specified Status parameter is invalid.
404 InvalidFileSystem.NotFound The specified file system does not exist. The error message returned because the specified file system does not exist.
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.