Help Center/ Scalable File Service Turbo/ API Reference/ API/ Storage Interworking Management/ Listing Data Import and Export Tasks
Updated on 2025-09-12 GMT+08:00
View PDF

Listing Data Import and Export Tasks

Function

This API is used to list data import and export tasks.

Constraints

  • This API is only supported for SFS Turbo 1,000 MB/s/TiB, 500 MB/s/TiB, 250 MB/s/TiB, 125 MB/s/TiB, 40 MB/s/TiB, and 20 MB/s/TiB file systems.

  • This API is only supported for NFS file systems.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

The project ID.

share_id

Yes

String

The file system ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

type

No

String

The task type. The value can be import (additional metadata import), import_metadata (quick import), preload (data preload), or export (export).

Enumeration values:

  • import

  • preload

  • export

  • import_metadata

status

No

String

The task status.

offset

No

Long

The offset. The default value is 0.

limit

No

Long

The limit. The default value is 1000.

start_time

No

String

start_time

end_time

No

String

end_time

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

The account token.

Content-Type

Yes

String

The MIME type.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-request-id

String

The request ID.
Table 5 Response body parameters

Parameter

Type

Description

tasks

Array of OneHpcCacheTaskInfoResp objects

The task details.

count

Long

The task quantity.
Table 6 OneHpcCacheTaskInfoResp

Parameter

Type

Description

task_id

String

The task ID.

type

String

The task type. The value can be import (additional metadata import), import_metadata (quick import), preload (data preload), or export (export).

Enumeration values:

  • import

  • preload

  • export

  • import_metadata

status

String

The task status.

Enumeration values:

  • SUCCESS

  • DOING

  • FAIL

  • DELETING

src_target

String

The interworking directory name.

src_prefix

String

The source path prefix specified in a data import or export task.

dest_target

String

Keep it the same as src_target.

dest_prefix

String

Keep it the same as src_prefix.

start_time

String

The task start time.

end_time

String

The task end time.

message

String

The task execution result.

Status code: 400

Table 7 Response header parameters

Parameter

Type

Description

X-request-id

String

The request ID.
Table 8 Response body parameters

Parameter

Type

Description

errCode

String

The error code.

errMsg

String

The error message.

Status code: 500

Table 9 Response header parameters

Parameter

Type

Description

X-request-id

String

The request ID.
Table 10 Response body parameters

Parameter

Type

Description

errCode

String

The error code.

errMsg

String

The error message.

Example Requests

Listing data import and export tasks for the file system whose ID is 77ba6f4b-6365-4895-8dda-bc7142af4dde

GET /v1/{project_id}/sfs-turbo/77ba6f4b-6365-4895-8dda-bc7142af4dde/hpc-cache/tasks

Example Responses

Status code: 200

Success

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

Status code: 400

Error response

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

Status code: 500

Error response

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

Status Codes

Status Code

Description

200

Success

400

Error response

500

Error response

Error Codes

See Error Codes.