ListLifecycleRetrieveJobs -

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	ListLifecycleRetrieveJobs	The operation that you want to perform. Set the value to ListLifecycleRetrieveJobs.
PageSize	Integer	No	10	The number of entries to return on each page. Valid values: 1 to 100. Default value: 10.
PageNumber	Integer	No	1	The number of the page to return. Pages start from page 1. Default value: 1.
FileSystemId	String	No	31a8e4****	The ID of the file system.
Status	String	No	completed	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 failed.

Response parameters


Parameter	Type	Example	Description
TotalCount	Integer	10	The total number of data retrieval tasks.
RequestId	String	BC7C825C-5F65-4B56-BEF6-98C56C7C****	The ID of the request.
PageSize	Integer	10	The number of entries returned per page.
PageNumber	Integer	1	The page number of the returned page.
LifecycleRetrieveJobs	Array of LifecycleRetrieveJob		The details about the data retrieval tasks.
FileSystemId	String	31a8e4****	The ID of the file system.
Status	String	completed	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 failed.
DiscoveredFileCount	Long	100	The total number of files that are read in the data retrieval task.
UpdateTime	String	2021-02-30T11:08:08Z	The time when the task was updated. The time follows the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format.
Paths	Array of String	["/pathway/to/folder","/pathway/to/folder","/pathway/to/folder"]	The directories or files that are retrieved. The path starts with a forward slash (/) and exists in the mount target.
RetrievedFileCount	Long	80	The total number of files that are retrieved.
JobId	String	lrj-nfstest-ia-160****853-hshvw	The ID of the data retrieval task.
CreateTime	String	2021-02-30T10:08:08Z	The time when the task was created. The time follows the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListLifecycleRetrieveJobs
&<Common request parameters>

Sample success responses

XML format

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

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

JSON format

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

{
  "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


HttpCode	Error code	Error message	Description
404	InvalidFileSystem.NotFound	The specified file system does not exist.	The error message returned because the specified file system does not exist.

For a list of error codes, see Service error codes.