更新时间:2024-10-22 GMT+08:00
分享

查看历史任务

功能介绍

查看任务ID指定的历史任务。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目编号。获取方法,请参见获取项目ID

instance_id

String

LakeFormation实例ID。创建实例时自动生成。例如:2180518f-42b8-4947-b20b-adfc53981a25。

job_id

String

任务ID。

表2 Query参数

参数

是否必选

参数类型

描述

status

String

CREATED:已创建、 SUBMITTED:已提交、 RUNNING:运行中、 SUCCESS:成功、 FAILED:失败、 STOPPED:已停止、 PARTIAL_SUCCESS:部分成功。

枚举值:

  • CREATED

  • SUBMITTED

  • RUNNING

  • SUCCESS

  • FAILED

  • STOPPED

  • PARTIAL_SUCCES

offset

Integer

分页查询时的偏移量。默认值为0。最小值为0,最大值为1000。

limit

Integer

分页一页显示数。默认值为10。最小值为1,最大值为1000。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

租户token。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

任务总数。

jobs

Array of JobInfo objects

任务列表。

表5 JobInfo

参数

参数类型

描述

id

String

任务Id。

name

String

任务名称。

type

String

任务类型:METADATA_MIGRATION:元数据迁移任务、PERMISSION_MIGRATION:数据权限迁移任务、METADATA_DISCOVERY:元数据发现任务。

枚举值:

  • METADATA_MIGRATION

  • PERMISSION_MIGRATION

  • METADATA_DISCOVERY

create_time

String

任务创建时间戳。

start_time

String

上次任务执行时间戳。

end_time

String

上次任务结束时间戳。

status

String

CREATED:已创建、 SUBMITTED:已提交、 RUNNING:运行中、 SUCCESS:成功、 FAILED:失败、 STOPPED:已停止、 FROZEN_RELEASABLE:冻结可恢复、 FROZEN_UNRELEASABLE:冻结不可恢复、 PARTIAL_SUCCESS:部分成功。

枚举值:

  • CREATED

  • SUBMITTED

  • RUNNING

  • SUCCESS

  • FAILED

  • STOPPED

  • FROZEN_RELEASABLE

  • FROZEN_UNRELEASABLE

  • PARTIAL_SUCCESS

execute_time

Long

任务执行时长,单位是秒。

log_simple_info

String

日志简略内容。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

common_error_code

String

CBC公共错误码。

solution_msg

String

解决方案描述。

状态码: 404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

common_error_code

String

CBC公共错误码。

solution_msg

String

解决方案描述。

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

common_error_code

String

CBC公共错误码。

solution_msg

String

解决方案描述。

请求示例

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

响应示例

状态码: 200

查询任务列表成功

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

状态码: 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"
}

状态码: 401

Unauthorized

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

状态码: 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"
}

状态码: 404

Not Found

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

状态码: 408

Request Timeout

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

状态码: 500

Internal Server Error

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

状态码

状态码

描述

200

查询任务列表成功

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

408

Request Timeout

500

Internal Server Error

错误码

请参见错误码

相关文档