All Products
Search
Document Center

Apsara File Storage NAS:ListRecycleBinJobs

Last Updated:Mar 14, 2024

Queries the jobs of the recycle bin.

Operation description

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
FileSystemIdstringYes

The ID of the file system.

1ca404****
JobIdstringNo

The job ID.

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

The number of entries per page.

Valid values: 1 to 100.

Default value: 10.

10
PageNumberlongNo

The page number.

Pages start from page 1. Default value: 1.

1
StatusstringNo

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.
  • Fail: The job failed.
  • Cancelled: The job is canceled.
  • All: all.Default value:All.
All

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

9E15E394-38A6-457A-A62A-D9797C9A****
TotalCountlong

The total number of jobs.

1
PageNumberlong

The page number.

1
PageSizelong

The number of jobs returned per page.

10
Jobsobject []

The information about the jobs of the recycle bin.

Idstring

The job ID.

8C****C54
Typestring

The type of the job. Valid values:

  • Restore: a file restoration job
  • Delete: a file deletion job
Restore
FileIdstring

The ID of the file or directory in the job.

04***08
Statusstring

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.
  • Fail: The job failed.
  • Cancelled: The job is canceled.
Running
ErrorCodestring

The error code.

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

Progressstring

The progress of the job.

Valid values: 1 to 100.

100
CreateTimestring

The time when the job was created.

2021-05-30T10:08:08Z
FileNamestring

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

test001
ErrorMessagestring

The error message.

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

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400IllegalCharactersThe parameter contains illegal characters.The parameter contains illegal characters.
400MissingFileSystemIdFileSystemId is mandatory for this action.-
400InvalidStatusSpecified parameter Status is not valid.The specified parameter Status is invalid.
404InvalidFileSystem.NotFoundThe specified file system does not exist.The specified file system does not exist.
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.