调用ListLifecycleRetrieveJobs查询数据取回任务列表-文件存储NAS-阿里云-文件存储NAS(NAS)-阿里云帮助中心

获取已创建的数据取回任务列表。

接口说明

仅通用型 NAS 文件系统支持该功能。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

nas:ListLifecycleRetrieveJobs

get

*FileSystem

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

无

请求参数

名称	类型	必填	描述	示例值
PageSize	integer	否	每个分页包含的数据取回任务个数。取值范围：1~100 默认值：10	10
PageNumber	integer	否	列表的分页页码。起始值（默认值）：1	1
FileSystemId	string	否	文件系统 ID。	31a8e4****
Status	string	否	数据取回任务的状态。取值： active：运行中。 canceled ：已取消。 completed：已完成。 failed：已失败。枚举值： canceled : 已取消 active : 运行中 completed : 已完成 failed : 已失败	completed
StorageType	string	否	分级存储类型。 InfrequentAccess：低频存储。 Archive：归档存储。说明如未指定 StorageType，则返回所有类型的数据取回任务信息。	InfrequentAccess

返回参数

名称	类型	描述	示例值
	object
TotalCount	integer	数据取回任务总数。	10
RequestId	string	请求 ID。	BC7C825C-5F65-4B56-BEF6-98C56C7C****
PageSize	integer	每个分页包含的数据取回任务个数。	10
PageNumber	integer	列表的分页页码。	1
LifecycleRetrieveJobs	array<object>	数据取回任务信息集合。
	object	数据取回任务信息集合。
FileSystemId	string	文件系统 ID。	31a8e4****
Status	string	数据取回任务的状态。包括： active：运行中。 canceled ：已取消。 completed：已完成。 failed：已失败。	completed
DiscoveredFileCount	integer	执行数据取回任务读取文件的总个数。	100
UpdateTime	string	任务更新时间。执行 ISO8601 标准表示，返回格式：`yyyy-MM-ddTHH:mm:ssZ`。	2021-02-30T11:08:08Z
Paths	array	指定取回任务的执行路径。
	string	指定取回的目录或文件。必须以正斜线（/）开头，并且是挂载点中真实存在的路径。	["/pathway/to/folder","/pathway/to/folder","/pathway/to/folder"]
RetrievedFileCount	integer	执行数据取回任务成功取回的文件个数。	80
JobId	string	数据取回任务 ID。	lrj-nfstest-ia-160****853-hshvw
CreateTime	string	任务创建时间。执行 ISO8601 标准表示，返回格式：`yyyy-MM-ddTHH:mm:ssZ`。	2021-02-30T10:08:08Z
StorageType	string	分级存储类型。 InfrequentAccess：低频存储。 Archive：归档存储。	InfrequentAccess

示例

正常返回示例

JSON格式

{
  "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"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidFileSystem.NotFound	The specified file system does not exist.	指定的文件系统不存在。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。