Help Center/ Scalable File Service/ API Reference/ SFS Turbo APIs/ Storage Interworking Management/ Querying Details About a Data Import or Export Task
Updated on 2025-07-22 GMT+08:00
View PDF
Share

Querying Details About a Data Import or Export Task

Function

This API is used to query details about a data import or export task.

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/task/{task_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

The project ID.

share_id

Yes

String

The file system ID.

task_id

Yes

String

The task ID.

Request Parameters

Table 2 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 3 Response header parameters

Parameter

Type

Description

X-request-id

String

The request ID.
Table 4 Response body parameters

Parameter

Type

Description

task_id

String

The task ID.

type

String

The task type.

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 5 Response header parameters

Parameter

Type

Description

X-request-id

String

The request ID.
Table 6 Response body parameters

Parameter

Type

Description

errCode

String

The error code.

errMsg

String

The error message.

Status code: 500

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.

Example Requests

Query details about a task whose ID is 11abef677ac40f46644d1d5cfc2424a4 for the file system whose ID is 77ba6f4b-6365-4895-8dda-bc7142af4dde

"GET HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/77ba6f4b-6365-4895-8dda-bc7142af4dde/hpc-cache/task/11abef677ac40f46644d1d5cfc2424a4"

Example Responses

Status code: 200

Success

{
  "task_id" : "7bd2a9b6-xxxx-4605-xxxx-512d636001b0",
  "type" : "import_metadata",
  "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" : ""
}

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.