Creates a data retrieval task.

Usage notes

You can run a maximum of 20 data retrieval tasks in one region within an Alibaba Cloud account.

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 CreateLifecycleRetrieveJob

The operation that you want to perform. Set the value to CreateLifecycleRetrieveJob.

FileSystemId String Yes 31a8e4****

The ID of the file system.

  • Sample ID of a General-purpose NAS file system: 31a8e4****.
  • The IDs of Extreme NAS file systems must start with extreme-. Example: extreme-0015****.
  • The IDs of Cloud Paralleled File System (CPFS) must start with cpfs-. Example: cpfs-125487****.
Paths.N String Yes ["/pathway/doc1","/pathway/doc2"]

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

The path must start with a forward slash (/). It must be a path that exists in the mount target. N represents the number of directories or files. Valid values of N: 1 to 10.

Response parameters

Parameter Type Example Description
RequestId String BC7C825C-5F65-4B56-BEF6-98C56C7C****

The ID of the request.

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

The ID of the data retrieval task.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateLifecycleRetrieveJob
&FileSystemId=31a8e4****
&Paths=["/pathway/doc1","/pathway/doc2"]
&Common request parameters

Sample success responses

XML format

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

<CreateLifecycleRetrieveJobResponse>
    <RequestId>BC7C825C-5F65-4B56-BEF6-98C56C7C****</RequestId>
    <JobId>lrj-nfstest-ia-160****853-hshvw</JobId>
</CreateLifecycleRetrieveJobResponse>

JSON format

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

{
  "RequestId" : "BC7C825C-5F65-4B56-BEF6-98C56C7C****",
  "JobId" : "lrj-nfstest-ia-160****853-hshvw"
}

Error codes

HttpCode Error code Error message Description
400 OperationDenied.FileSystemNotSupportedForLifecycle The file system does not support lifecycle. The error message returned because the specified file system does not support lifecycle management.
400 OperationDenied.EncryptedFileSystemNotSupportedForLifecycle The encrypted file system does not support lifecycle. The error message returned because an encrypted file system does not support lifecycle management.
400 OperationDenied.LifecycleRetrieveJobCountLimitExceeded The maximum number of LifecycleRetrieveJobs is exceeded. The error message returned because the maximum number of data retrieval tasks is reached.
404 InvalidFileSystem.NotFound The specified file system does not exist. The error message returned because the specified file system does not exist.
404 InvalidParameter.PathNotExist The specified path does not exist. The error message returned because the specified path does not exist.

For a list of error codes, visit the API Error Center.