# 根据条件分页列举任务信息 - ListJobsByInstance #### 功能介绍 根据条件分页列举任务信息，支持按任务名称模糊查询，支持按最近执行状态过滤。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/LakeFormation/doc?api=ListJobsByInstance)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-lakeformation/abcd.html)。 #### URI GET /v1/{project_id}/instances/{instance_id}/lf-jobs 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释:** 项目编号。获取方法，请参见[获取项目ID](https://support.huaweicloud.com/api-lakeformation/lakeformation_04_0026.html) **约束限制:** 不涉及 **取值范围:** 不涉及 **默认取值:** 不涉及 | | instance_id | 是 | String | **参数解释:** LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25 **约束限制:** 不涉及 **取值范围:** 不涉及 **默认取值:** 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name_pattern | 否 | String | **参数解释:** 任务名通配符，用于任务名的匹配 **约束限制:** 不涉及 **取值范围:** 不涉及 **默认取值:** 不涉及 | | type | 是 | String | **参数解释:** METADATA_MIGRATION：元数据迁移 PERMISSION_MIGRATION：数据权限迁移 METADATA_DISCOVERY：元数据发现 DISASTER_RECOVERY：容灾任务 **约束限制:** 最小长度为1，可选值为：METADATA_MIGRATION, PERMISSION_MIGRATION, METADATA_DISCOVERY, name: status **取值范围:** 最小长度为1 **默认取值:** METADATA_MIGRATION | | status | 否 | String | **参数解释:** CREATED：已创建 SUBMITTED：已提交 RUNNING：运行中 SUCCESS：成功 FAILED：失败 STOPPED：已停止 PARTIAL_SUCCESS：部分成功 **约束限制:** 最小长度为1，可选值为：CREATED, SUBMITTED, RUNNING, SUCCESS, FAILED, STOPPED, PARTIAL_SUCCESS, name: offset **取值范围:** 最小长度为1 **默认取值:** 不涉及 | | offset | 是 | Integer | **参数解释:** 分页查询时的偏移量。默认值为0。最小值为0，最大值为1000 **约束限制:** 取值为0\~1000 **取值范围:** 取值为0\~1000 **默认取值:** 0 | | limit | 是 | Integer | **参数解释:** 分页一页显示数。默认值为10。最小值为1，最大值为1000 **约束限制:** 取值为1\~1000 **取值范围:** 取值为1\~1000 **默认取值:** 10 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | **参数解释:** 租户token **约束限制:** 长度为0\~65535个字符 **取值范围:** 长度为0\~65535个字符 **默认取值:** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | **参数解释:** 任务总数 | | jobs | Array of [JobInfo] objects | **参数解释:** 任务列表 | 表5JobInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释:** 任务Id | | name | String | **参数解释:** 任务名称 | | type | String | **参数解释:** 任务类型：METADATA_MIGRATION：元数据迁移任务、PERMISSION_MIGRATION：数据权限迁移任务、METADATA_DISCOVERY：元数据发现任务、DISASTER_RECOVERY：容灾同步任务 | | create_time | String | **参数解释:** 任务创建时间戳 | | start_time | String | **参数解释:** 上次任务执行时间戳 | | end_time | String | **参数解释:** 上次任务结束时间戳 | | status | String | **参数解释:** CREATED：已创建 SUBMITTED：已提交 RUNNING：运行中 SUCCESS：成功 FAILED：失败 STOPPED：已停止 FROZEN_RELEASABLE：冻结可恢复 FROZEN_UNRELEASABLE：冻结不可恢复 PARTIAL_SUCCESS：部分成功 | | execute_time | Long | **参数解释:** 任务执行时长，单位是秒 | | log_simple_info | String | **参数解释:** 日志简略内容 | | parameters | Map\ | **参数解释:** 任务运行时参数 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释:** 错误码 | | error_msg | String | **参数解释:** 错误描述 | | common_error_code | String | **参数解释:** CBC公共错误码 | | solution_msg | String | **参数解释:** 解决方案描述 | **状态码：401** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释:** 错误码 | | error_msg | String | **参数解释:** 错误描述 | | common_error_code | String | **参数解释:** CBC公共错误码 | | solution_msg | String | **参数解释:** 解决方案描述 | **状态码：403** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [Error] object | **参数解释:** 错误信息 | | error_code | String | **参数解释:** 错误码 | | error_msg | String | **参数解释:** 错误描述 | | title | String | **参数解释:** 标题 | 表9Error | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释:** 错误码 | | error_msg | String | **参数解释:** 错误描述 | | title | String | **参数解释:** 标题 | | message | String | **参数解释:** 错误信息 | | code | String | **参数解释:** 状态码 | **状态码：404** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释:** 错误码 | | error_msg | String | **参数解释:** 错误描述 | | common_error_code | String | **参数解释:** CBC公共错误码 | | solution_msg | String | **参数解释:** 解决方案描述 | **状态码：408** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释:** 错误码 | | error_msg | String | **参数解释:** 错误描述 | | common_error_code | String | **参数解释:** CBC公共错误码 | | solution_msg | String | **参数解释:** 解决方案描述 | **状态码：500** 表12响应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 ``` #### 响应示例 **状态码：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 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-lakeformation/ErrorCode.html)。