ListLifecycleRetrieveJobs - File Storage NAS - Alibaba Cloud Documentation Center

Queries data retrieval tasks.

Operation description

Only General-purpose NAS file systems support this operation.

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:ListLifecycleRetrieveJobs	get	*FileSystem `acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 100. Default value: 10.	10
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
FileSystemId	string	No	The ID of the file system.	31a8e4****
Status	string	No	The status of the data retrieval task. Valid values: active: The task is running. canceled: The task is canceled. completed: The task is completed. failed: The task has failed.	completed
StorageType	string	No	The storage class. InfrequentAccess: the Infrequent Access (IA) storage class. Archive: the Archive storage class. Note If the StorageType parameter is not specified, data retrieval tasks of all types are returned.	InfrequentAccess

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The total number of data retrieval tasks.	10
RequestId	string	The ID of the request.	BC7C825C-5F65-4B56-BEF6-98C56C7C****
PageSize	integer	The number of entries returned per page.	10
PageNumber	integer	The page number of the returned page.	1
LifecycleRetrieveJobs	array<object>	The details about the data retrieval tasks.
LifecycleRetrieveJob	object
FileSystemId	string	The ID of the file system.	31a8e4****
Status	string	The status of the data retrieval task. Valid values: active: The task is running. canceled: The task is canceled. completed: The task is completed. failed: The task has failed.	completed
DiscoveredFileCount	long	The total number of files that are read in the data retrieval task.	100
UpdateTime	string	The time when the task was updated. The time follows the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format.	2021-02-30T11:08:08Z
Paths	array	The execution path of the data retrieval task.
Path	string	The directories or files that are retrieved. Each path starts with a forward slash (/) and exists in the mount target.	["/pathway/to/folder","/pathway/to/folder","/pathway/to/folder"]
RetrievedFileCount	long	The total number of files that are retrieved.	80
JobId	string	The ID of the data retrieval task.	lrj-nfstest-ia-160****853-hshvw
CreateTime	string	The time when the task was created. The time follows the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format.	2021-02-30T10:08:08Z
StorageType	string	The storage class. InfrequentAccess: the IA storage class. Archive: the Archive storage class.	InfrequentAccess

Examples

Sample success responses

JSONformat

{
  "TotalCount": 10,
  "RequestId": "BC7C825C-5F65-4B56-BEF6-98C56C7C****",
  "PageSize": 10,
  "PageNumber": 1,
  "LifecycleRetrieveJobs": [
    {
      "FileSystemId": "31a8e4****",
      "Status": "completed",
      "DiscoveredFileCount": 100,
      "UpdateTime": "2021-02-30T11:08:08Z",
      "Paths": [
        "[\"/pathway/to/folder\",\"/pathway/to/folder\",\"/pathway/to/folder\"]"
      ],
      "RetrievedFileCount": 80,
      "JobId": "lrj-nfstest-ia-160****853-hshvw",
      "CreateTime": "2021-02-30T10:08:08Z",
      "StorageType": "InfrequentAccess"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidFileSystem.NotFound	The specified file system does not exist.	The specified file system does not exist.

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

Change history

Change time	Summary of changes	Operation
2024-03-25	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details