文档首页/ 高性能弹性文件服务 SFS Turbo/ API参考/ API/ 存储联动管理/ 查询数据导入导出任务列表 - ListHpcCacheTasks
更新时间:2026-09-30 GMT+08:00
分享

查询数据导入导出任务列表 - ListHpcCacheTasks

功能介绍

查询数据导入导出任务列表。

接口约束

  • 该接口仅适用于SFS Turbo 20MB/s/TiB、40MB/s/TiB、125MB/s/TiB、250MB/s/TiB、500MB/s/TiB、1000MB/s/TiB、100MB/s/TiB-智算型、200MB/s/TiB-智算型文件系统。

  • 该接口仅适用于NFS文件系统共享协议。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/sfs-turbo/{share_id}/hpc-cache/tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,用于标识资源所属的IAM项目空间,实现项目级资源隔离与权限管控。

获取方法请参见获取项目ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

share_id

是

String

参数解释:

文件系统ID,用于唯一标识SFS Turbo文件系统实例。

获取方法请参见查询文件系统列表接口。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

type

否

String

参数解释:

任务类型,用于按操作方式过滤查询结果。

不传该参数时,返回所有类型的任务。

约束限制:

不涉及。

取值范围:

  • import:附加元数据导入。

  • import_metadata:快速导入。

  • preload:数据预热。

  • export:数据导出。

默认取值:

不涉及。

status

否

String

参数解释:

任务状态,用于按任务执行阶段过滤查询结果。

不传该参数时,返回所有状态的任务。

约束限制:

不涉及。

取值范围:

  • SUCCESS:任务执行成功。

  • DOING:任务执行中。

  • FAIL:任务执行失败。

  • DELETING:任务删除中。

  • CANCELED:任务已取消。

默认取值:

不涉及。

offset

否

Long

参数解释:

分页偏移量,用于指定查询结果的起始位置。

约束限制:

不涉及。

取值范围:

大于等于0的整数。

默认取值:

0

limit

否

Long

参数解释:

每页显示的任务数量上限,用于分页查询。

约束限制:

不涉及。

取值范围:

1~1000的整数。

默认取值:

1000

start_time

否

String

参数解释:

查询任务的起始时间,用于按任务开始时间过滤查询结果。

约束限制:

不涉及。

取值范围:

采用UTC时间格式,格式为yyyy-MM-ddTHH:mm:ss,如2023-09-02T15:04:05。

默认取值:

不涉及。

end_time

否

String

参数解释:

查询任务的结束时间,用于按任务结束时间过滤查询结果。

约束限制:

不涉及。

取值范围:

采用UTC时间格式,格式为yyyy-MM-ddTHH:mm:ss,如2023-09-02T15:04:05。

默认取值:

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token,用于鉴权认证。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

Content-Type

是

String

参数解释:

请求消息体MIME类型,用于标识请求正文的数据格式。

约束限制:

不涉及。

取值范围:

application/json

默认取值:

application/json

响应参数

状态码:200

表4 响应Header参数

参数

参数类型

描述

X-request-id

String

参数解释:

请求ID,用于唯一标识和追踪本次请求。

取值范围:

不涉及。

表5 响应Body参数

参数

参数类型

描述

tasks

Array of OneHpcCacheTaskInfoResp objects

参数解释:

任务详情列表,每个元素为一个数据导入导出任务的详细信息。

取值范围:

不涉及。

count

Long

参数解释:

满足查询条件的任务总数。

取值范围:

不涉及。

表6 OneHpcCacheTaskInfoResp

参数

参数类型

描述

task_id

String

参数解释:

任务ID,用于唯一标识一个数据导入导出任务。

取值范围:

不涉及。

type

String

参数解释:

任务类型,用于标识数据导入导出任务的操作方式。

取值范围:

  • import:附加元数据导入,会导入OBS对象的元数据(名称、大小、最后修改时间)以及来源于SFS Turbo导出时的附加元数据(如uid、gid、mode)。

  • import_metadata:快速导入,仅会导入OBS对象的元数据(名称、大小、最后修改时间),不会导入其它附加元数据(如uid、gid、mode),SFS Turbo会生成默认的附加元数据。

  • preload:数据预热,会同时导入元数据和数据内容,元数据导入采用快速导入方式,不会导入其它附加元数据(如uid、gid、mode)。

  • export:数据导出,会将联动目录里创建的文件,以及对从OBS导入后又做过修改的文件导出存储到OBS桶里。

status

String

参数解释:

任务状态,用于标识任务的当前执行阶段。

取值范围:

  • SUCCESS:任务执行成功。

  • DOING:任务执行中。

  • FAIL:任务执行失败。

  • DELETING:任务删除中。

  • CANCELED:任务已取消。

src_target

String

参数解释:

联动目录名称,指定文件系统中与OBS后端存储建立联动关系的子目录名称。

取值范围:

不涉及。

src_prefix

String

参数解释:

导入导出任务的源端路径前缀,用于过滤需要同步的对象。

导入时为OBS桶内的相对路径前缀,导出时为联动目录下的相对路径前缀。

取值范围:

不涉及。

dest_target

String

参数解释:

目标端联动目录名称,当前只支持和src_target保持一致。

取值范围:

不涉及。

dest_prefix

String

参数解释:

目标端路径前缀,当前只支持和src_prefix保持一致。

取值范围:

不涉及。

start_time

String

参数解释:

任务开始时间。

取值范围:

采用UTC时间格式,格式为yyyy-MM-ddTHH:mm:ss,如2023-09-02T15:04:05。

end_time

String

参数解释:

任务结束时间,任务未完成时该字段为空字符串。

取值范围:

采用UTC时间格式,格式为yyyy-MM-ddTHH:mm:ss,如2023-09-02T15:04:05。

message

String

参数解释:

任务执行结果信息。

任务执行成功时为空字符串,任务执行失败时返回错误原因描述。

取值范围:

不涉及。

状态码:400

表7 响应Header参数

参数

参数类型

描述

X-request-id

String

参数解释:

请求ID,用于唯一标识和追踪本次请求。

取值范围:

不涉及。

表8 响应Body参数

参数

参数类型

描述

errCode

String

参数解释:

错误码,用于标识请求失败的原因。详细错误码请参见错误码。

取值范围:

不涉及。

errMsg

String

参数解释:

错误描述,用于描述请求失败的具体原因,便于排查问题。请参见错误码。

取值范围:

不涉及。

状态码:500

表9 响应Header参数

参数

参数类型

描述

X-request-id

String

参数解释:

请求ID,用于唯一标识和追踪本次请求。

取值范围:

不涉及。

表10 响应Body参数

参数

参数类型

描述

errCode

String

参数解释:

错误码,用于标识请求失败的原因。详细错误码请参见错误码。

取值范围:

不涉及。

errMsg

String

参数解释:

错误描述,用于描述请求失败的具体原因,便于排查问题。请参见错误码。

取值范围:

不涉及。

请求示例

文件系统ID为“77ba6f4b-6365-4895-8dda-bc7142af4dde”, 查询数据导入导出任务列表。

GET /v1/2b31ed520xxxxxxebedb6e57xxxxxxxx/sfs-turbo/77ba6f4b-6365-4895-8dda-bc7142af4dde/hpc-cache/tasks

响应示例

状态码:200

{
  "tasks" : [ {
    "task_id" : "7bd2a9b6-xxxx-4605-xxxx-512d636001b0",
    "type" : "import",
    "status" : "DOING",
    "src_target" : "sfs-link-directory",
    "src_prefix" : "input/datasets/",
    "dest_target" : "sfs-link-directory",
    "dest_prefix" : "input/datasets/",
    "message" : "",
    "start_time" : "2023-09-02T15:04:05",
    "end_time" : ""
  } ],
  "count" : 1
}

状态码:400

{
  "errCode" : "SFS.TURBO.0001",
  "errMsg" : "parameter error"
}

状态码:500

{
  "errCode" : "SFS.TURBO.0005",
  "errMsg" : "Internal server error"
}

状态码

状态码

描述

200

成功

400

错误响应

500

错误响应

错误码

请参见错误码。

相关文档