Use ListLifecycleRetrieveJobs to query data retrieval tasks - File Storage NAS - Alibaba Cloud - File Storage NAS

Retrieves the list of created data retrieval tasks.

Operation description

Only General-purpose NAS file systems support this feature.

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:ListLifecycleRetrieveJobs

get

*FileSystem

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

None

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The number of data retrieval tasks on each page. Valid values: 1 to 100. Default value: 10.	10
PageNumber	integer	No	The page number of the list. Start value (default value): 1.	1
FileSystemId	string	No	The file system ID.	31a8e4****
Status	string	No	The status of the data retrieval task. Valid values: active: running. canceled: canceled. completed: completed. failed: failed. Valid values: canceled : Canceled. active : Running. completed : Completed. failed : Failed.	completed
StorageType	string	No	The storage class. Valid values: InfrequentAccess: IA storage class. Archive: Archive storage class. Note If StorageType is not specified, data retrieval tasks of all storage classes are returned.	InfrequentAccess

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of data retrieval tasks.	10
RequestId	string	The request ID.	BC7C825C-5F65-4B56-BEF6-98C56C7C****
PageSize	integer	The number of data retrieval tasks on each page.	10
PageNumber	integer	The page number of the list.	1
LifecycleRetrieveJobs	array<object>	The collection of data retrieval task information.
	object	The collection of data retrieval task information.
FileSystemId	string	The file system ID.	31a8e4****
Status	string	The status of the data retrieval task. Valid values: active: running. canceled: canceled. completed: completed. failed: failed.	completed
DiscoveredFileCount	integer	The total number of files read by the data retrieval task.	100
UpdateTime	string	The time when the task was last updated. The time follows the ISO 8601 standard in the format of `yyyy-MM-ddTHH:mm:ssZ`.	2021-02-30T11:08:08Z
Paths	array	The execution paths of the data retrieval task.
	string	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/to/folder","/pathway/to/folder","/pathway/to/folder"]
RetrievedFileCount	integer	The number of files successfully retrieved by the data retrieval task.	80
JobId	string	The data retrieval task ID.	lrj-nfstest-ia-160****853-hshvw
CreateTime	string	The time when the task was created. The time follows the ISO 8601 standard in the format of `yyyy-MM-ddTHH:mm:ssZ`.	2021-02-30T10:08:08Z
StorageType	string	The storage class. Valid values: InfrequentAccess: IA storage class. Archive: Archive storage class.	InfrequentAccess

Examples

Success response

JSON format

{
  "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",
      "StorageType": "InfrequentAccess"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidFileSystem.NotFound	The specified file system does not exist.	The specified file system does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.