Creates a data retrieval task.
Operation description
- Only General-purpose NAS file systems support this operation.
- You can run a maximum of 20 data retrieval tasks in each region within an Alibaba Cloud account.
Debugging
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 Resourcesis 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:CreateLifecycleRetrieveJob | create |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| FileSystemId | string | Yes | The ID of the file system. | 31a8e4**** |
| Paths | array | Yes | The directories or files that you want to retrieve. You can specify a maximum of 10 paths. | |
| string | Yes | The directory or file that you want to retrieve. The path must start with a forward slash (/) and must be a path that exists in the mount target. | ["/pathway/doc1","/pathway/doc2"] | |
| StorageType | string | No | The storage class.
| InfrequentAccess |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "BC7C825C-5F65-4B56-BEF6-98C56C7C****",
"JobId": "lrj-nfstest-ia-160****853-hshvw"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | OperationDenied.FileSystemNotSupportedForLifecycle | The file system does not support lifecycle. | The file system does not support lifecycle. |
| 400 | OperationDenied.EncryptedFileSystemNotSupportedForLifecycle | The encrypted file system does not support lifecycle. | The encrypted file system does not support lifecycle. |
| 400 | OperationDenied.LifecycleRetrieveJobCountLimitExceeded | The maximum number of LifecycleRetrieveJobs is exceeded. | The maximum number of LifecycleRetrieveJobs is exceeded. |
| 404 | InvalidFileSystem.NotFound | The specified file system does not exist. | The specified file system does not exist. |
| 404 | InvalidParameter.PathNotExist | The specified path does not exist. | The specified path does not exist. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-09-05 | API Description Update. The Error code has changed | View Change Details |
| 2024-03-25 | The Error code has changed. The request parameters of the API has changed | View Change Details |