Help Center/ DataArts Lake Formation/ API Reference/ API/ Console/ Job Management/ Listing Tasks by Condition on Different Page
Updated on 2024-02-21 GMT+08:00
View PDF
Share

Listing Tasks by Condition on Different Page

Function

This API is used to list task information on multiple pages based on search criteria. Fuzzy query by task name and filtering by latest execution status are supported.

URI

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

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 (lakeformation_04_0026.xml).

instance_id

Yes

String

LakeFormation instance ID. The value is automatically generated when the instance is created, for example, 2180518f-42b8-4947-b20b-adfc53981a25.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

name_pattern

No

String

Wildcard of the task name, which is used to match the task name.

type

Yes

String

METADATA_MIGRATION: metadata migration PERMISSION_MIGRATION data permission migration METADATA_DISCOVERY metadata discovery

Enumeration values:

  • METADATA_MIGRATION

  • PERMISSION_MIGRATION

  • METADATA_DISCOVERY

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 task failed. STOPPED: The job has been stopped.

Enumeration values:

  • CREATED

  • SUBMITTED

  • RUNNING

  • SUCCESS

  • FAILED

  • STOPPED

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

Yes

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.

status

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.

Enumeration values:

  • CREATED

  • SUBMITTED

  • RUNNING

  • SUCCESS

  • FAILED

  • STOPPED

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

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