ListRecycleBinJobs - File Storage NAS - Alibaba Cloud Documentation Center

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

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
nas:ListRecycleBinJobs	get	FileSystem acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	The ID of the file system.	1ca404****
JobId	string	No	The job ID.	rb-15**ed-r-1625**2441
PageSize	long	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10
PageNumber	long	No	The page number. Pages start from page 1. Default value: 1.	1
Status	string	No	The job status. 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 (default)	All

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	9E15E394-38A6-457A-A62A-D9797C9A****
TotalCount	long	The total number of jobs.	1
PageNumber	long	The page number.	1
PageSize	long	The number of jobs returned per page.	10
Jobs	array<object>	The information about the jobs of the recycle bin.
Job	object
Id	string	The job ID.	8C****C54
Type	string	The type of the job. Valid values: Restore: a file restoration job Delete: a file deletion job	Restore
FileId	string	The ID of the file or directory in the job.	04***08
Status	string	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.	Fail
ErrorCode	string	The error code returned. A valid value is returned only if you set the Status parameter to Fail or PartialSuccess.	InvalidFileId.NotFound
Progress	string	The progress of the job. Valid values: 1 to 100.	100
CreateTime	string	The time when the job was created.	2021-05-30T10:08:08Z
FileName	string	The name of the file or directory that is associated with the job.	test001
ErrorMessage	string	The error message. A valid value is returned only if you set the Status parameter to Fail or PartialSuccess.	The Target File or Directory does not exist.

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": "Fail",
      "ErrorCode": "InvalidFileId.NotFound",
      "Progress": "100",
      "CreateTime": "2021-05-30T10:08:08Z",
      "FileName": "test001",
      "ErrorMessage": "The Target File or Directory does not exist."
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalCharacters	The parameter contains illegal characters.	The parameter contains illegal characters.
400	MissingFileSystemId	FileSystemId is mandatory for this action.	-
400	InvalidStatus	Specified parameter Status is not valid.	The specified parameter Status is invalid.
404	InvalidFileSystem.NotFound	The specified file system does not exist.	The specified file system does not exist.
404	InvalidJobId.NotFound	The 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 time	Summary of changes	Operation

No change history