错误码
9 Flink 作业相关 API
9.8 查询作业详情
"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 输入参数无效。
错误码
调用接口出错后，将不会返回上述结果，而是返回错误码和错误信息，更多介绍请参 见错误码。
9.8 查询作业详情
功能介绍
查看一个作业的详情信息。
调试
您可以在API Explorer中调试该接口。
URI
● URI格式
API 参考 9 Flink 作业相关 API
● 参数说明
表9-39 URI 参数说明 参数名称 是否必
选
参数类 型
说明
project_i
d 是 String 项目编号，用于资源隔离。获取方式请参考获 取项目ID。
job_id 是 String 作业ID。
请求消息
无请求参数。
响应消息
表9-40 响应参数说明
参数名称 是否必选 参数类型 说明
is_success 否 Boolean 执行请求是否成功。“true”表示请求 执行成功。
message 否 String 系统提示信息，执行成功时，信息可能 为空。
job_detail 否 Object 作业详情。请参见表9-41。
表9-41 Job_detail 参数说明
参数名称 是否
必选
参数类 型
说明
job_id 否 Long 作业ID。
name 否 String 作业名称。长度限制：0-57个字符。
desc 否 String 作业描述。长度限制：0-512个字符。
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自定义作业
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：已完成 status_desc 否 String 作业状态描述。
create_time 否 Long 作业创建时间。
start_time 否 Long 作业启动时间。
user_id 否 String 作业所属用户标识。
queue_nam
e 否 String 队列名称。长度限制：1-128个字符。
project_id 否 String 作业所属项目标识。
sql_body 否 String Stream SQL语句。
savepoint_p
ath 否 String 手动产生的Checkpoint的保存路径。
run_mode 否 String 作业运行模式。
● shared_cluster：共享
● exclusive_cluster：独享
● edge_node：边缘节点
job_config 否 Object 作业配置, 具体参数说明请参见表9-42。
API 参考 9 Flink 作业相关 API
参数名称 是否 必选
参数类 型
说明
main_class 否 String jar包主类。例如，
org.apache.spark.examples.streaming.JavaQue ueStream
entrypoint_a
rgs 否 String jar包作业运行参数，多个参数之间空格分隔。
execution_gr
aph 否 String 作业执行计划。
update_time 否 Long 作业更新时间。
表9-42 job_config 参数说明
参数名称 是否
● exactly_once：数据只被消费一次。
● at_least_once：数据至少被消费一次。
默认值为“exactly_once”。
log_enabled 否 Boolean 是否启用日志存储。默认为“false”。
obs_bucket 否 String OBS桶名。
root_id 否 Integer 父作业ID。
edge_group_ids 否 Array of
Strings 边缘计算组ID列表。多个ID以逗号分隔。
manager_cu_nu
mber 否 Integer 管理单元CU数。默认为“1”。
graph_editor_e
nabled 否 Boolean 流图编辑开关。默认为“false”。
graph_editor_d
ata 否 String 流图编辑数据。默认为null。
executor_numb
er 否 Integer 作业使用计算节点个数。
API 参考 9 Flink 作业相关 API
参数名称 是否
mber 否 Integer 计算节点cu数。
cu_number 否 Integer 用户为作业选择的CU数量。 “show_detail”
为“true”时独有。
● 最小值：2
● 最大值：400 默认为“2”。
parallel_numbe
r 否 Integer 用户设置的作业并行数。 “show_detail”为
“true”时独有。
● 最小值：1
● 最大值：2000 默认为“1”。
smn_topic 否 String SMN主题名。当作业异常时，向该SMN主题 推送告警信息。
restart_when_e
xception 否 Boolean 是否开启异常重启功能。
resume_checkp
oint 否 Boolean 异常自动重启时，是否从最新checkpoint恢 复。默认值为“false”。
config_url 否 String 用户上传的config包OBS路径。
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资源管理系统的程序包名，
用户自定义作业的其他依赖包。
API 参考 9 Flink 作业相关 API
参数名称 是否
Strings 用户已上传到DLI资源管理系统的资源包名，
用户自定义作业的依赖文件。
tm_cus 否 int 单TM所占CU数。
tm_slot_num 否 int 单TM Slot数。
image 否 String 自定义镜像。格式为：组织名/镜像名:镜像版
feature 否 String 自定义作业特性。表示用户作业使用的Flink镜 像类型。
● basic：表示使用DLI提供的基础Flink镜像。
● custom：表示使用用户自定义的Flink镜 像。
flink_version 否 String Flink版本。当用户设置“feature”为
“basic”时，该参数生效。用户可通过与
“feature”参数配合使用，指定作业运行使用 的DLI基础Flink镜像的版本。
operator_config 否 String 各算子并行度参数，以json的形式展示各算子 id和并行度。
static_estimato
r_config 否 String 静态流图资源预估参数，以json的形式展示。
runtime_config 否 String Flink作业运行时自定义优化参数。
示例
● 请求样例
None
● 响应样例
作业类型为：flink_jar_job，参考响应样例如下：
{ "is_success": "true",
"message": "作业详情查询成功", "job_detail": {
"job_id": 104,
"user_id": "011c99a26ae84a1bb963a75e7637d3fd", "queue_name": "flinktest",
"project_id": "330e068af1334c9782f4226acc00a2e2", "name": "jptest",
"desc": "", "sql_body": "",
"run_mode": "exclusive_cluster",
API 参考 9 Flink 作业相关 API
"job_type": "flink_jar_job",
{ "is_success": "true",
"message": "The job information query succeeds.", "job_detail": {
"job_type": "flink_opensource_sql_job", "status_desc": "",
"create_time": 1637632872828, "sql_body": "xxx",
"savepoint_path": null, "main_class": null,
"queue_name": "xie_container_general", "execution_graph": "xxx",
"executor_cu_number": null,
"udf_jar_url": "test/flink_test-1.0-SNAPSHOT-jar-with-dependencies.jar", "dirty_data_strategy": "0",
"entrypoint": "test/flink_test-1.0-SNAPSHOT-jar-with-dependencies.jar", "dependency_jars": null,
"run_mode": "exclusive_cluster", "job_id": 90634,
"name": "test_guoquan", "desc": "",
"entrypoint_args": null, "status": "job_cancel_success"
}