Queries the newly created data retrieval jobs.

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 job.

Valid values:

  • active: The job is running.
  • canceled: The job is canceled.
  • completed: The job is completed.
  • failed: The job failed.

Response parameters

Parameter Type Example Description
LifecycleRetrieveJobs Array of LifecycleRetrieveJob

The details about the data retrieval job.

CreateTime String 2021-02-30T10:08:08Z

The time when the job was created.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.

DiscoveredFileCount Long 100

The total number of files that are read in the data retrieval job.

FileSystemId String 31a8e4****

The ID of the file system.

JobId String lrj-nfstest-ia-160****853-hshvw

The ID of the data retrieval job.

Paths List ["/pathway/to/folder","/pathway/to/folder","/pathway/to/folder"]

Indicates the directory or file whose data you want to retrieve.

The path must be prefixed by a forward slash (/). It must be a path that exists in the mount target.

RetrievedFileCount Long 80

The number of files that are retrieved from the IA storage medium.

Status String complete

The status of the data retrieval job.

Valid values:

  • active: The job is running.
  • canceled: The job is canceled.
  • completed: The job is completed.
  • failed: The job has failed.
UpdateTime String 2021-02-30T11:08:08Z

The time when the job was updated.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page.

RequestId String BC7C825C-5F65-4B56-BEF6-98C56C7C****

The ID of the request.

TotalCount Integer 10

The number of data retrieval jobs.

Examples

Sample requests

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

Sample success responses

XML format 

<RequestId>BC7C825C-5F65-4B56-BEF6-98C56C7C****</RequestId>
<TotalCount>1</TotalCount>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<LifecycleRetrieveJobs>
    <CreateTime>2020-10-30T10:08:08Z</CreateTime>
    <UpdateTime>2021-01-30T10:08:08Z</UpdateTime>
    <JobId>lrj-nfstest-ia-160****375-clrrt</JobId>
    <Paths>/pathway/to/folder</Paths>
    <Paths>/pathway/to/folder</Paths>
    <Paths>/pathway/to/folder</Paths>
    <FileSystemId>434****123</FileSystemId>
    <Status>active</Status>
    <RetrievedFileCount>50</RetrievedFileCount>
    <DiscoveredFileCount>100</DiscoveredFileCount>
</LifecycleRetrieveJobs>

JSON format 

{
    "RequestId": "BC7C825C-5F65-4B56-BEF6-98C56C7C****",
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 10,
    "LifecycleRetrieveJobs": [
      {
        "CreateTime": "2020-10-30T10:08:08Z",
        "UpdateTime":"2021-01-30T10:08:08Z",
        "JobId": "lrj-nfstest-ia-160****375-clrrt",
        "Paths": [
          "/pathway/to/folder",
          "/pathway/to/folder",
          "/pathway/to/folder"
        ],
        "FileSystemId": "434****123",
        "Status": "active",
        "RetrievedFileCount": 50,
        "DiscoveredFileCount": 100
      }
    ]
  }

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, visit the API Error Center.