错误码
9 Flink 作业相关 API
9.7 查询作业列表
功能介绍
查询当前用户的作业列表，可以根据作业ID作为ID，查询大于ID或小于ID的限定条数 的作业，默认查询全部状态的作业，也可以设定运行中或其他状态条件。
调试
您可以在API Explorer中调试该接口。
URI
● URI格式
GET /v1.0/{project_id}/streaming/jobs
● 参数说明
表9-32 URI 参数说明 参数名称 是否必
选
参数类 型
说明
project_id 是 String 项目编号，用于资源隔离。获取方式请参考 获取项目ID。
表9-33 query 参数说明
参数名称 是否必选 参数类 型
说明
job_type 否 String 作业类型：
● flink_sql_job：flink sql作业
● flink_opensource_sql_job：flink opensource sql作业
● flink_sql_edge_job：flink sql边缘作 业
API 参考 9 Flink 作业相关 API
参数名称 是否必选 参数类 型
说明
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 作业偏移量。
root_job_id 否 Integer 边缘父作业ID, 用于查询指定边缘作业的 子作业。不使用该参数时, 查询所有非边 缘作业和边缘父作业, 不包括边缘子作 业。
API 参考 9 Flink 作业相关 API
参数名称 是否必选 参数类 型
说明
show_detail 否 Boolea
n 是否返回作业详情信息。默认为
“false”。为“true”时，返回作业详 情。具体可见查询作业详情。
user_name 否 String 用户名，可作为筛选条件。
tags 否 String 指定标签过滤。
sys_enterpris e_project_na me
否 String 企业项目名称。
请求消息
无请求参数。
响应消息
表9-34 响应参数说明 参数名称 是否必
选 参数类型 说明
is_succes
s 否 Boolean 执行请求是否成功。“true”表示请求执行成 功。
message 否 String 系统提示信息，执行成功时，信息可能为空。
job_list 否 Object 作业列表信息。请参见表9-35。
表9-35 Job_list 参数说明
参数名称 是否必选 参数类型 说明
total_coun
t 否 Integer 作业查询结果条数。
jobs 否 Array of
Objects 作业信息。请参见表9-36。
表9-36 Jobs 参数说明 参数名称 是否
必选
参数类型 说明
API 参考 9 Flink 作业相关 API
参数名称 是否 必选
参数类型 说明
name 否 String 作业名称。长度限制：0-57个字符。
desc 否 String 作业描述。长度限制：0-512个字符。
username 否 String 用户名，当“show_detail”为“false”时独有。
job_type 否 String 作业类型。
● flink_sql_job：flink sql作业
● flink_opensource_sql_job：flink opensource sql作业
● flink_sql_edge_job：flink sql边缘作业
● flink_jar_job：flink自定义作业 status 否 String 作业状态。
status_de
sc 否 String 作业状态描述。
create_ti
me 否 Long 作业创建时间。
start_time 否 Long 作业启动时间。“0”表示尚未启动。
duration 否 Long 作业运行时长。 单位ms，“show_detail”为
“false”时独有。
root_id 否 Long 父作业ID。“show_detail”为“false”时独有。
graph_edi tor_enabl ed
否 Boolean 作业的流图是否可编辑。“true”表示作业的流 图可以编辑，“false”表示作业的流图不可以编 辑。
has_savep
oint 否 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_confi
g 否 Object 作业配置。 “show_detail”为“false”时独 有。具体参数说明请参见表9-37。
API 参考 9 Flink 作业相关 API
参数名称 是否 必选
参数类型 说明
main_clas
s 否 String jar包主类。“show_detail”为“false”时独有。
entrypoin
t_args 否 String jar包作业运行参数。多个参数之间用空格分隔。
“show_detail”为“true”时独有。
execution
_graph 否 String 作业执行计划。“show_detail”为“false”时独 有。
update_ti
me 否 Long 作业更新时间。“show_detail”为“false”时独 有。
表9-37 job_config 参数说明
参数名称 是否
必选
参数类 型
说明
checkpoint_ena
bled 否 Boolean 是否开启作业自动快照功能。
● true：开启
● false：关闭 默认为“false”。
checkpoint_mo
de 否 String 快照模式,。两种可选：
● exactly_once：数据只被消费一次。
● at_least_once：数据至少被消费一次。
默认值为“exactly_once”。
checkpoint_inte
rval 否 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_nu
mber 否 Integer 管理单元CU数。默认为“1”。
API 参考 9 Flink 作业相关 API
参数名称 是否 必选
参数类 型
说明
cu_number 否 Integer 用户为作业选择的CU数量。 “show_detail”
为“true”时独有。
● 最小值：2
● 最大值：400 默认为“2”。
parallel_numbe
r 否 Integer 用户设置的作业并行数。 “show_detail”为
“true”时独有。
● 最小值：1
● 最大值：2000 默认为“1”。
restart_when_e
xception 否 Boolean 是否开启异常重启功能。
idle_state_reten
tion 否 Integer 空闲状态过期周期。
udf_jar_url 否 String 用户已上传到DLI资源管理系统的程序包名，
用户sql作业的udf jar通过该参数传入。
dirty_data_strat
egy 否 String 作业脏数据策略。
● “2:obsDir”：保存，obsDir表示脏数据存 储路径。
● “1”：抛出异常。
● “0”：忽略。
entrypoint 否 String 用户已上传到DLI资源管理系统的程序包名，
用户自定义作业主类所在的jar包。
dependency_jar
s 否 Array of
Strings 用户已上传到DLI资源管理系统的程序包名，
用户自定义作业的其他依赖包。
dependency_fil
es 否 Array of
Strings 用户已上传到DLI资源管理系统的资源包名，
用户自定义作业的依赖文件。
executor_numb
er 否 Integer 作业使用计算节点个数。
executor_cu_nu
mber 否 Integer 计算节点cu数。
resume_checkp
oint 否 Boolean 异常自动重启时，是否从最新checkpoint恢 复。默认值为“false”。
示例
● 请求样例
None
API 参考 9 Flink 作业相关 API
● 响应样例
{ "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 }
] } }
状态码
状态码如表9-38所示。
表9-38 状态码
状态码 描述
200 查询作业列表成功。
400 输入参数无效。
错误码
调用接口出错后，将不会返回上述结果，而是返回错误码和错误信息，更多介绍请参 见错误码。