ListLifecycleRetrieveJobs - Apsara File Storage NAS - Alibaba Cloud Documentation Center

Queries data retrieval tasks.

Operation description

Only General-purpose NAS file systems support this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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

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	object []	The details about the data retrieval tasks.
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
	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

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"
    }
  ]
}

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.