All Products
Search

This Product

    File Storage NAS:CreateLifecycleRetrieveJob

    Document Center

    File Storage NAS:CreateLifecycleRetrieveJob

    Last Updated:Jun 25, 2026

    Creates a data retrieval task.

    Operation description

    • Only General-purpose NAS file systems support this feature.

    • Each Alibaba Cloud account can have up to 20 running data retrieval tasks in the same region.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    nas:CreateLifecycleRetrieveJob

    create

    *FileSystem

    acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    FileSystemId

    string

    Yes

    The file system ID.

    31a8e4****
    Paths

    array

    Yes

    The list of directories or file paths to retrieve. You can specify up to 10 paths.

    Paths.1=/pathway/doc1,Paths.2=/pathway/doc2

    string

    No

    The directory or file to retrieve.

    The path must start with a forward slash (/) and must be an existing path in the mount target.

    /pathway/doc1
    StorageType

    string

    No

    The storage class. Valid values:

    • InfrequentAccess (default): IA storage class.

    • Archive: Archive storage class.

    Valid values:

    • Archive :

      Archive storage class.

    • InfrequentAccess :

      IA storage class.

    InfrequentAccess

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    BC7C825C-5F65-4B56-BEF6-98C56C7C****
    JobId

    string

    The data retrieval task ID.

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

    Examples

    Success response

    JSON format

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

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.