查询作业列表

功能介绍

查询当前用户的作业列表，可以根据作业ID作为ID，查询大于ID或小于ID的限定条数的作业，默认查询全部状态的作业，也可以设定运行中或其他状态条件。

URI

URI格式
 GET /v1.0/{project_id}/streaming/jobs

参数说明

表1 URI参数说明
参数名称	是否必选	参数类型	说明
project_id	是	String	项目编号，用于资源隔离。获取方式请参考获取项目ID。

表2 query参数说明
参数名称	是否必选	参数类型	说明
job_type	否	String	作业类型： flink_sql_job：flink sql作业 flink_opensource_sql_job：flink opensource sql作业 flink_jar_job：flink自定义作业
status	否	String	作业状态码。作业的状态如下： job_init：草稿 job_submitting：提交中 job_submit_fail：提交失败 job_running：运行中（开始计费，提交作业后，返回正常结果） job_running_exception：运行异常（停止计费。作业发生运行时异常，停止运行作业） job_downloading：下载中 job_idle：空闲 job_canceling：停止中 job_cancel_success：已停止 job_cancel_fail：停止失败 job_savepointing：保存点创建中 job_arrearage_stopped：因欠费被停止（结束计费。用户账户欠费，作业停止） job_arrearage_recovering：欠费作业恢复中（用户账户欠费，账户充值，作业恢复中） job_finish：已完成
queue_name	否	String	队列名称。
order	否	String	查询结果排序。 asc：按照时间顺序升序排列 desc：按照时间顺序降序排列默认为“desc”。
limit	否	Integer	返回的数据条数。默认为“10”，最大值为“100”。
name	否	String	作业名称。长度限制：0-57个字符。
offset	否	Integer	作业偏移量。
show_detail	否	Boolean	是否返回作业详情信息。默认为“false”。为“true”时，返回作业详情。具体可见查询作业详情。
user_name	否	String	用户名，可作为筛选条件。
tags	否	String	指定标签过滤。

请求消息

无请求参数。

响应消息

表3 响应参数说明
参数名称	是否必选	参数类型	说明
is_success	否	String	执行请求是否成功。“true”表示请求执行成功。
message	否	String	系统提示信息，执行成功时，信息可能为空。
job_list	否	Object	作业列表信息。请参见表4。

表4 job_list参数说明
参数名称	是否必选	参数类型	说明
total_count	否	Integer	作业查询结果条数。
jobs	否	Array of Objects	作业信息。请参见表5。

表5 Jobs参数说明
参数名称	是否必选	参数类型	说明
job_id	否	Long	作业ID。
name	否	String	作业名称。长度限制：0-57个字符。
desc	否	String	作业描述。长度限制：0-512个字符。
user_name	否	String	用户名，当“show_detail”为“false”时独有。
job_type	否	String	作业类型。 flink_sql_job：flink sql作业 flink_opensource_sql_job：flink opensource sql作业 flink_jar_job：flink自定义作业
status	否	String	作业状态。
status_desc	否	String	作业状态描述。
create_time	否	Long	作业创建时间。
start_time	否	Long	作业启动时间。“0”表示尚未启动。
duration	否	Long	作业运行时长。单位ms，“show_detail”为“false”时独有。
root_id	否	Long	父作业ID。“show_detail”为“false”时独有。
graph_editor_enabled	否	Boolean	作业的流图是否可编辑。“true”表示作业的流图可以编辑，“false”表示作业的流图不可以编辑。
has_savepoint	否	Boolean	作业是否有保存点。“true”表示作业有保存点，“false”表示作业没有保存点。
user_id	否	String	作业所属用户标识。 “show_detail”为“true”时独有。
project_id	否	String	作业所属项目标识。 “show_detail”为“true”时独有。
sql_body	否	String	Stream SQL语句。 “”“show_detail”为“false”时独有。
run_mode	否	String	作业运行模式。包括共享、独享模式和边缘节点。“show_detail”为“true”时独有。 shared_cluster：共享 exclusive_cluster：独享 edge_node：边缘节点
job_config	否	Object	作业配置。 “show_detail”为“false”时独有。具体参数说明请参见表6。
main_class	否	String	jar包主类。“show_detail”为“false”时独有。
entrypoint_args	否	String	jar包作业运行参数。多个参数之间用空格分隔。“show_detail”为“true”时独有。
execution_graph	否	String	作业执行计划。“show_detail”为“false”时独有。
update_time	否	Long	作业更新时间。“show_detail”为“false”时独有。
queue_name	否	String	队列名称。
edge_group_ids	否	Array of Strings	边缘计算组ID列表。多个ID以逗号分隔。
restart_times	否	Integer	重启次数。
savepoint_path	否	String	手动产生的Checkpoint的保存路径。

表6 job_config参数说明
参数名称	是否必选	参数类型	说明
checkpoint_enabled	否	Boolean	是否开启作业自动快照功能。 true：开启 false：关闭默认为“false”。
checkpoint_mode	否	String	快照模式,。两种可选： exactly_once：数据只被消费一次。 at_least_once：数据至少被消费一次。默认值为“exactly_once”。
checkpoint_interval	否	Integer	快照时间间隔。单位为秒，默认值为“10”。
log_enabled	否	Boolean	是否启用日志存储。默认为“false”。
obs_bucket	否	String	OBS桶名。
smn_topic	否	String	SMN主题名。当作业异常时，向该SMN主题推送告警信息。
root_id	否	Integer	父作业ID。
edge_group_ids	否	Array of Strings	边缘计算组ID列表。多个ID以逗号分隔。
manager_cu_number	否	Integer	管理单元CU数。默认为“1”。
cu_number	否	Integer	用户为作业选择的CU数量。 “show_detail”为“true”时独有。最小值：2 最大值：400 默认为“2”。
parallel_number	否	Integer	用户设置的作业并行数。 “show_detail”为“true”时独有。最小值：1 最大值：2000 默认为“1”。
restart_when_exception	否	Boolean	是否开启异常重启功能。
idle_state_retention	否	Integer	空闲状态过期周期。
udf_jar_url	否	String	用户已上传到DLI资源管理系统的程序包名，用户sql作业的udf jar通过该参数传入。
dirty_data_strategy	否	String	作业脏数据策略。 “2:obsDir”：保存，obsDir表示脏数据存储路径。 “1”：抛出异常。 “0”：忽略。
entrypoint	否	String	用户已上传到DLI资源管理系统的程序包名，用户自定义作业主类所在的jar包。
dependency_jars	否	Array of Strings	用户已上传到DLI资源管理系统的程序包名，用户自定义作业的其他依赖包。
dependency_files	否	Array of Strings	用户已上传到DLI资源管理系统的资源包名，用户自定义作业的依赖文件。
executor_number	否	Integer	作业使用计算节点个数。
executor_cu_number	否	Integer	计算节点cu数。
resume_checkpoint	否	Boolean	异常自动重启时，是否从最新checkpoint恢复。默认值为“false”。
runtime_config	否	String	Flink作业运行时自定义优化参数。
graph_editor_enabled	否	Boolean	流图编辑开关。默认为“false”。
graph_editor_data	否	String	流图编辑数据。默认为null。
resume_max_num	否	Integer	异常重试最大次数。-1代表无限。
checkpoint_path	否	String	检查点保存路径。
config_url	否	String	用户上传的config包OBS路径。
tm_cus	否	int	单TM所占CU数。
tm_slot_num	否	int	单TM Slot数。
image	否	String	自定义镜像。格式为：组织名/镜像名:镜像版本。当用户设置“feature”为“custom”时，该参数生效。用户可通过与“feature”参数配合使用，指定作业运行使用自定义的Flink镜像。关于如何使用自定义镜像，请参考《数据湖探索用户指南》。
feature	否	String	自定义作业特性。表示用户作业使用的Flink镜像类型。 basic：表示使用DLI提供的基础Flink镜像。 custom：表示使用用户自定义的Flink镜像。
flink_version	否	String	Flink版本。当用户设置“feature”为“basic”时，该参数生效。用户可通过与“feature”参数配合使用，指定作业运行使用的DLI基础Flink镜像的版本。
operator_config	否	String	各算子并行度参数，以json的形式展示各算子id和并行度。
static_estimator_config	否	String	静态流图资源预估参数，以json的形式展示。
real_cu_number	否	Integer	实际使用的CU数。默认值为“0”，表示此时以“cu_number”的值为准。

请求示例

无

响应示例

{
    "is_success": "true",
    "message": "作业列表查询成功",
    "job_list": {
        "total_count": 26,
        "jobs": [
            {
                "job_id": 146,
                "name": "aaaaa",
                "desc": "",
                "user_name": "",
                "job_type": "flink_sql_job",
                "status": "job_init",
                "status_desc": "",
                "create_time": 1578892414688,
                "duration": 0,
                "root_id": -1,
                "graph_editor_enabled": false,
                "has_savepoint": false
            }
        ]
    }
}

状态码

状态码如表7所示。

表7 状态码
状态码	描述
200	查询作业列表成功。
400	输入参数无效。

错误码

调用接口出错后，将不会返回上述结果，而是返回错误码和错误信息，更多介绍请参见错误码。

父主题： Flink作业相关API

上一篇：批量运行作业

下一篇：查询作业详情

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消