文档

ListLifecycleRetrieveJobs - 查询数据取回任务列表

更新时间:

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

接口说明

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
nas:ListLifecycleRetrieveJobsRead
  • FileSystem
    acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId}

请求参数

名称类型必填描述示例值
PageSizeinteger

每个分页包含的数据取回任务个数。

取值范围:1~100

默认值:10

10
PageNumberinteger

列表的分页页码。

起始值(默认值):1

1
FileSystemIdstring

文件系统 ID。

31a8e4****
Statusstring

数据取回任务的状态。取值:

  • active:运行中。
  • canceled :已取消。
  • completed:已完成。
  • failed:已失败。
completed

返回参数

名称类型描述示例值
object
TotalCountinteger

数据取回任务总数。

10
RequestIdstring

请求 ID。

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

每个分页包含的数据取回任务个数。

10
PageNumberinteger

列表的分页页码。

1
LifecycleRetrieveJobsobject []

数据取回任务信息集合。

FileSystemIdstring

文件系统 ID。

31a8e4****
Statusstring

数据取回任务的状态。包括:

  • active:运行中。
  • canceled :已取消。
  • completed:已完成。
  • failed:已失败。
completed
DiscoveredFileCountlong

执行数据取回任务读取文件的总个数。

100
UpdateTimestring

任务更新时间。

执行 ISO8601 标准表示,返回格式:yyyy-MM-ddTHH:mm:ssZ

2021-02-30T11:08:08Z
Pathsarray
string

指定取回的目录或文件。

必须以正斜线(/)开头,并且是挂载点中真实存在的路径。

["/pathway/to/folder","/pathway/to/folder","/pathway/to/folder"]
RetrievedFileCountlong

执行数据取回任务成功取回的文件个数。

80
JobIdstring

数据取回任务 ID。

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

任务创建时间。

执行 ISO8601 标准表示,返回格式:yyyy-MM-ddTHH:mm:ssZ

2021-02-30T10:08:08Z

示例

正常返回示例

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

错误码

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

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

  • 本页导读 (1)
文档反馈