On this page

Show all

Help Center/ DataArts Lake Formation/ API Reference/ API/ Console/ Job Management/ Viewing Historical Tasks

Viewing Historical Tasks

Updated on 2025-02-14 GMT+08:00

View PDF

Function

This API is used to view the historical task specified by the task ID.

URI

GET /v1/{project_id}/instances/{instance_id}/lf-jobs/{job_id}/history

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For how to obtain the project ID, see Obtaining a Project ID.
instance_id	Yes	String	LakeFormation instance ID. The value is automatically generated when the instance is created, for example, 2180518f-42b8-4947-b20b-adfc53981a25.
job_id	Yes	String	Job ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
status	No	String	CREATED: The job is created. SUBMITTED: The job is submitted. RUNNING: The job is in progress. SUCCESS: The job has been executed. FAILED: The job failed. STOPPED: The job has been stopped. PARTIAL_SUCCESS: The job is partially successful. Enumeration values: CREATED SUBMITTED RUNNING SUCCESS FAILED STOPPED PARTIAL_SUCCES
offset	Yes	Integer	Offset of the page-based query. The default value is 0. The value ranges from 0 to 1000.
limit	Yes	Integer	Number of records displayed on one page. The default value is 10. The value ranges from 1 to 1000.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Tenant token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Total number of tasks.
jobs	Array of JobInfo objects	Task list.

**Table 5** JobInfo
Parameter	Type	Description
id	String	Job ID.
name	String	Job name.
type	String	Job type. METADATA_MIGRATION indicates a metadata migration job, PERMISSION_MIGRATION indicates a data permission migration job, and METADATA_DISCOVERY indicates a metadata discovery job. Enumeration values: METADATA_MIGRATION PERMISSION_MIGRATION METADATA_DISCOVERY
create_time	String	Job creation timestamp.
start_time	String	Execution timestamp of the last job.
end_time	String	Timestamp when the last task ends.
status	String	CREATED SUBMITTED RUNNING SUCCESS FAILED STOPPED FROZEN_RELEASABLE FROZEN_UNRELEASABLE PARTIAL_SUCCESS Enumeration values: CREATED SUBMITTED RUNNING SUCCESS FAILED STOPPED FROZEN_RELEASABLE FROZEN_UNRELEASABLE PARTIAL_SUCCESS
execute_time	Long	Task execution duration, in seconds.
log_simple_info	String	Brief content of the logs.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
common_error_code	String	CBC common error code.
solution_msg	String	Solution.

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
common_error_code	String	CBC common error code.
solution_msg	String	Solution.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
common_error_code	String	CBC common error code.
solution_msg	String	Solution.

Example Requests

GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/lf-jobs/{job_id}/history

Example Responses

Status code: 200

Successful query on the job list.

{
  "total" : 1,
  "jobs" : [ {
    "id" : "03141229-84cd-4b1b-9733-dd124320c125",
    "name" : "testjob",
    "type" : "METADATA_MIGRATION",
    "create_time" : "2023-05-27T10:04:35.743Z",
    "start_time" : "2023-05-27T10:04:35.743Z",
    "status" : {
      "status" : "SUCCESS"
    }
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

Status code: 401

Unauthorized

{
  "error_code": 'APIG.1002',
  "error_msg": 'Incorrect token or token resolution failed'
}

Status code: 403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "error_code" : null,
    "error_msg" : null,
    "title" : "Forbidden"
  },
  "error_code" : "403",
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

Status code: 404

Not Found

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}

Status code: 408

Request Timeout

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

Status code: 500

Internal Server Error

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

Status Codes

Status Code	Description
200	Successful query on the job list.
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
408	Request Timeout
500	Internal Server Error

Error Codes

See Error Codes.

Parent topic: Job Management

Previous topic: Checking the Logs of a Job

Next topic: Service Authorization Management

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot