Querying Details About a Task

Function

Used to query the execution status of the asynchronous API of an SFS Turbo file system.

URI

GET /v1/{project_id}/sfs-turbo/jobs/{job_id}

Table 1 Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
job_id	Yes	String	job ID

Request Parameters

Table 2 Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Account token
Content-Type	Yes	String	MIME type

Response Parameters

Status code: 200

Table 3 Response header parameters
Parameter	Type	Description
X-request-id	String	Request ID

Table 4 Response body parameters
Parameter	Type	Description
status	String	Task status, which can be success, running, failed, or waiting
job_id	String	Task ID
job_type	String	Task type
begin_time	String	Task start time in UTC format, for example, '2016-01-02 15:04:05
end_time	String	Task end time in UTC format, for example, '2016-01-02 15:04:05
error_code	String	Error code returned if the task execution fails
fail_reason	String	Cause of the task execution failure
sub_jobs	Array of GetSubJobDetail objects	List of subtasks

Table 5 GetSubJobDetail
Parameter	Type	Description
status	String	Subtask status, which can be success, running, failed, or waiting
job_id	String	Task ID
job_type	String	Subtask type
begin_time	String	Task start time in UTC format, for example, '2016-01-02 15:04:05
end_time	String	Task end time in UTC format, for example, '2016-01-02 15:04:05
error_code	String	Error code returned if the task execution fails
fail_reason	String	Cause of the task execution failure

Status code: 400

Table 6 Response body parameters
Parameter	Type	Description
errCode	String	Error code
errMsg	String	Error description

Status code: 404

Table 7 Response body parameters
Parameter	Type	Description
errCode	String	Error code
errMsg	String	Error description

Status code: 500

Table 8 Response body parameters
Parameter	Type	Description
errCode	String	Error code
errMsg	String	Error description

Example Requests

None

Example Responses

Status code: 200

Response body parameters

{
  "job_id" : "26f6b565-xxxx-XXXX-xxxx-03f0bd975433",
  "status" : "success",
  "job_type" : "bind_ldap",
  "begin_time" : "2023-07-26 09:33:58",
  "end_time" : "2023-07-26 09:33:58"
}

Status code: 400

Client error

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

Status code: 404

Resource not found

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

Status code: 500

Internal error

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

Status Codes

Status Code	Description
200	Response body parameters
400	Client error
404	Resource not found
500	Internal error

Error Codes

See Error Codes.

Parent topic: Task Management

Предыдущая статья

Task Management

Следующая статья

Permissions Policies and Supported Actions

Была ли эта статья полезна?

Поддержка Юридические документы