错误码
9 Flink 作业相关 API
9.5 更新 Flink Jar 作业
功能介绍
该API用于更新用户自定义作业，目前仅支持Jar格式，运行在独享队列中。
调试
您可以在API Explorer中调试该接口。
URI
● URI格式
PUT /v1.0/{project_id}/streaming/flink-jobs/{job_id}
● 参数说明
表9-22 URI 参数说明 参数名称 是否必
选 参数类
型 说明
project_id 是 String 项目编号，用于资源隔离。获取方式请参考获 取项目ID。
job_id 是 Long 作业ID。
请求消息
表9-23 参数说明
参数名称 是否必
选
参数类 型
说明
name 否 String 作业名称。长度限制：0-57个字符。
desc 否 String 作业描述。长度限制：0-512个字符。
API 参考 9 Flink 作业相关 API
参数名称 是否必 选
参数类 型
说明
cu_number 否 Integer 用户为作业选择的CU数量。默认值为“2”。
manager_cu_n
umber 否 Integer 用户为作业选择的管理节点CU数量，对应为 flink jobmanager数量。默认值为“1”。
parallel_numb
er 否 Integer 用户为作业选择的并发量。默认值为“1”。
log_enabled 否 Boolea
n 是否开启作业日志。
● 开启：true
● 关闭：false
● 默认：false
obs_bucket 否 String 当“log_enabled”为“true”时，用户授权 保存日志的OBS路。
smn_topic 否 String 当作业异常时，向该SMN主题推送告警信 息。
main_class 否 String 作业入口类。
entrypoint_arg
s 否 String 作业入口类参数，多个参数之间空格分隔。
restart_when_e
xception 否 Boolea
n 是否开启异常重启功能，默认值为
“false”。
entrypoint 否 String 用户已上传到DLI资源管理系统的程序包名，
用户自定义作业主类所在的jar包。
dependency_ja
rs 否 Array
ofStrings
用户已上传到DLI资源管理系统的程序包名，
ofStrings
用户已上传到DLI资源管理系统的资源包名，
用户自定义作业的依赖文件。
示例："myGroup/test.cvs,myGroup/
test1.csv"
tm_cus 否 Integer 每个taskmanager的CU数，默认值为“1”。
tm_slot_num 否 Integer 每个taskmanager的slot数，默认值为
“(parallel_number*tm_cus)/(cu_number-manager_cu_number)”。
API 参考 9 Flink 作业相关 API
参数名称 是否必 选
参数类 型
说明
feature 否 String 作业特性。表示用户作业使用的Flink镜像类 型。
● basic：表示使用DLI提供的基础Flink镜 像。
● custom：表示使用用户自定义的Flink镜 像。
flink_version 否 String Flink版本。当用户设置“feature”为
“basic”时，该参数生效。用户可通过与
“feature”参数配合使用，指定作业运行使 用的DLI基础Flink镜像的版本。
image 否 String 自定义镜像。格式为：组织名/镜像名:镜像版 本。
当用户设置“feature”为“custom”时，该 参数生效。用户可通过与“feature”参数配 合使用，指定作业运行使用自定义的Flink镜 像。关于如何使用自定义镜像，请参考《数 据湖探索用户指南》。
resume_checkp
oint 否 Boolea
n 异常重启是否从checkpoint恢复。
resume_max_n
um 否 Integer 异常重试最大次数，单位：次/小时。取值范 围：-1或大于0。默认值为“-1”，表示无限 次数。
checkpoint_pat
h 否 String 用户Jar中checkpoint的储存地址，不同作业 路径需要保持不同。
runtime_config 否 String Flink作业运行时自定义优化参数。
响应消息
表9-24 响应参数说明
参数名称 是否必选 参数类型 说明
is_success 否 Boolean 执行请求是否成功。“true”表示请求执行 成功。
message 否 String 消息内容。
job 否 object 作业更新信息。具体请参考表9-25。
API 参考 9 Flink 作业相关 API
表9-25 job 参数说明
参数名称 是否必选 参数类
型
说明
update_time 否 Long 作业更新时间，单位为毫秒。
示例
● 请求样例
{ "name": "test1", "desc": "job for test", "job_type": "flink_jar_job", "queue_name": "testQueue", "manager_cu_number": 1, "cu_number": 2,
"parallel_number": 1, "log_enabled": false,
"main_class": "org.apache.flink.examples.streaming.JavaQueueStream", "restart_when_exception": false,
"entrypoint": "FemaleInfoCollec.jar", "dependency_jars": [
"myGroup/test.jar", "myGroup/test1.jar"
],
"dependency_files": [ "myGroup/test.csv", "myGroup/test1.csv"
] }
● 响应样例
{ "is_success": true,
"message": "更新flink作业成功", "job": {
"update_time": 1516952770835 } }
状态码
状态码如表9-26所示。
表9-26 状态码
状态码 描述
200 更新Flink自定义作业成功。
400 输入参数无效。
错误码
调用接口出错后，将不会返回上述结果，而是返回错误码和错误信息，更多介绍请参 见错误码。
API 参考 9 Flink 作业相关 API