查询作业列表 - ListFactoryJobs
功能介绍
查询作业列表清单
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v2/{project_id}/factory/jobs
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID,获取方法请参见项目ID和账号ID。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 分页返回结果,指定每页最大记录数。范围[1,1000] 默认值:100 |
| offset | 否 | Integer | 分页列表的页数,默认值为0,取值范围大于等于0。 |
| job_type | 否 | String | 作业类型: - REAL_TIME: 实时处理 - BATCH: 批处理(默认) |
| job_name | 否 | String | 作业名称。 |
| job_id | 否 | String | 作业ID,多个ID以英文逗号分隔,最多50个。 |
| status | 否 | String | 作业状态: |
| need_alarms | 否 | Boolean | 是否需要返回作业配置的告警信息。 |
| tags | 否 | String | 作业标签。 |
| match_all_tags | 否 | Boolean | 匹配所有标签。 |
| connection_name | 否 | String | 数据连接名称。 |
| source_type | 否 | String | 源端数据连接类型(集成类型作业)。 |
| source_name | 否 | String | 源端数据连接名称(集成类型作业)。 |
| sink_type | 否 | String | 目的端数据连接类型(集成类型作业)。 |
| sink_name | 否 | String | 目的端数据连接名称(集成类型作业)。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 作业总数 |
| jobs | Array of JobResultV2 objects | 作业列表 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | String | 作业名称 |
| job_type | String | 作业类型 |
| status | String | 作业状态 |
| create_user | String | 创建人 |
| create_time | Long | 创建时间戳,单位毫秒 |
| start_time | Long | 开始时间戳,单位毫秒 |
| end_time | Long | 结束时间戳,单位毫秒 |
| last_instance_status | String | 最近一次实例状态 |
| last_instance_end_time | Long | 最近实例结束时间戳,单位毫秒 |
| owner | String | 作业负责人 |
| last_update_user | String | 最后更新人 |
| priority | Integer | 优先级 |
| flink_job_info | String | Flink作业信息(JSON格式) |
| path | String | 作业路径 |
| single_node_job_flag | Boolean | 是否为单任务作业 |
| alarms | Array of JobAlarm objects | 告警信息列表 |
| last_update_time | Long | 最后更新时间戳,单位毫秒 |
| single_node_job_type | String | 单任务作业 |
| empty_running_job | String | 空跑作业标识 |
| next_plan_time | String | 下次计划执行时间。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
请求示例
/v2/{project_id}/factory/jobs?limit=2 响应示例
状态码:200
{
"jobs" : [ {
"create_time" : 1778730096000,
"create_user" : "ei_dlf_l00341563",
"empty_running_job" : "0",
"job_type" : "BATCH",
"last_instance_end_time" : 1778730592000,
"last_instance_status" : "success",
"last_update_time" : 1778730327000,
"last_update_user" : "ei_dlf_l00341563",
"name" : "migrationJob_6328",
"owner" : "ei_dlf_l00341563",
"path" : "/",
"priority" : 0,
"single_node_job_flag" : true,
"single_node_job_type" : "NormalJob",
"next_plan_time" : "2025-09-26T00:00:00+08",
"status" : "STOPPED"
}, {
"create_time" : 1777360805000,
"create_user" : "ei_dlf_l00341563",
"job_type" : "BATCH",
"last_update_time" : 1777361094000,
"last_update_user" : "ei_dlf_l00341563",
"name" : "MRSspark12AA",
"owner" : "ei_dlf_l00341563",
"path" : "/",
"priority" : 0,
"single_node_job_flag" : false,
"next_plan_time" : "2025-09-26T00:00:00+08",
"status" : "STOPPED"
} ],
"total" : 68
} 状态码:400
查询失败
{
"error_code" : "DLF.3051",
"error_msg" : "The request parameter is invalid."
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | |
| 400 | 查询失败 |