错误码
9 Flink 作业相关 API
9.4 新建 Flink Jar 作业
"dirty_data_strategy": "0", "udf_jar_url": "group/test.jar"
}
● 响应样例
{ "is_success": "true", "message": "作业更新成功",
调试
您可以在API Explorer中调试该接口。
URI
● URI格式
POST /v1.0/{project_id}/streaming/flink-jobs
● 参数说明
表9-16 URI 参数说明 参数名称 是否必
选 参数
类型 说明
project_id 是 String 项目编号，用于资源隔离。获取方式请参考获 取项目ID。
请求消息
表9-17 参数说明
参数名称 是否必
选
参数类 型
说明
name 是 String 作业名称。长度限制：0-57个字符。
desc 否 String 作业描述。长度限制：0-512个字符。
queue_name 否 String 队列名称。长度限制：1-128个字符。
cu_number 否 Integer 用户为作业选择的CU数量。
manager_cu_num
ber 否 Integer 用户为作业选择的管理节点CU数量，对应 为flink jobmanager数量。默认值为
“1”。
parallel_number 否 Integer 用户为作业选择的并发量。
log_enabled 否 Boolea
n 是否开启作业日志。
● 开启：true
● 关闭：false
● 默认：false
obs_bucket 否 String 当“log_enabled”为“true”时, 用户授 权保存作业日志的OBS桶名。
smn_topic 否 String 当作业异常时，向该SMN主题推送告警信 息。
API 参考 9 Flink 作业相关 API
参数名称 是否必 选
参数类 型
说明
entrypoint_args 否 String 作业入口类参数，多个参数之间空格分 隔。
restart_when_exc
eption 否 Boolea
n 是否开启异常重启功能，默认值为
“false”。
entrypoint 否 String 用户已上传到DLI资源管理系统的程序包 名，用户自定义作业主类所在的jar包。
dependency_jars 否 Array ofStrings
用户已上传到DLI资源管理系统的程序包 名，用户自定义作业的其他依赖包。
示例“myGroup/test.jar,myGroup/
test1.jar”。
dependency_files 否 Array ofStrings
用户已上传到DLI资源管理系统的资源包
tm_cus 否 Integer 每个taskmanager的CU数，默认值为
“1”。
tm_slot_num 否 Integer 每个taskmanager的slot数，默认值为
“(parallel_number*tm_cus)/
(cu_number-manager_cu_number)”。
feature 否 String 作业特性。表示用户作业使用的Flink镜像 类型。
● basic：表示使用DLI提供的基础Flink镜 像。
● custom：表示使用用户自定义的Flink 镜像。
flink_version 否 String Flink版本。当用户设置“feature”为
“basic”时，该参数生效。用户可通过与
“feature”参数配合使用，指定作业运行 使用的DLI基础Flink镜像的版本。
API 参考 9 Flink 作业相关 API
参数名称 是否必 选
参数类 型
说明
image 否 String 自定义镜像。格式为：组织名/镜像名:镜 像版本。
当用户设置“feature”为“custom”
时，该参数生效。用户可通过与
“feature”参数配合使用，指定作业运行 使用自定义的Flink镜像。关于如何使用自 定义镜像，请参考《数据湖探索用户指 南》。
resume_checkpoi
nt 否 Boolea
n 异常重启是否从checkpoint恢复。
resume_max_nu
m 否 Integer 异常重试最大次数，单位：次/小时。取值
范围：-1或大于0。默认值为“-1”，表示 无限次数。
checkpoint_path 否 String 用户Jar中checkpoint的储存地址，不同作 业路径需要保持不同。
tags 否 Array
ofObjects
Flink jar作业的标签。具体请参考表
9-18。
runtime_config 否 String Flink作业运行时自定义优化参数。
表9-18 tags 参数 参数名称 是否必
选
参数类型 说明
key 是 String 标签的键。
value 是 String 标签的值。
响应消息
表9-19 响应参数说明
参数名称 是否必选 参数类型 说明
is_success 否 Boolean 执行请求是否成功。“true”表示请求执行 成功。
message 否 String 消息内容。
job 否 Object 作业状态信息。具体请参考表9-20。
API 参考 9 Flink 作业相关 API
表9-20 job 参数说明
参数名称 是否必选 参数类型 说明 job_id 是 Long 作业ID。
status_name 否 String 当前状态名称。
status_desc 否 String 当前状态描述。包含异常状态原因及建 议。
示例
● 请求样例
{ "name": "test", "desc": "job for test", "queue_name": "testQueue", "manager_cu_number": 1, "cu_number": 2,
"parallel_number": 1, "tm_cus": 1, "tm_slot_num": 1, "log_enabled": true,
"obs_bucket": "bucketName", "smn_topic": "topic",
"main_class": "org.apache.flink.examples.streaming.JavaQueueStream", "restart_when_exception": false,
"entrypoint": "javaQueueStream.jar", "entrypoint_args":"-windowSize 2000 -rate3", "dependency_jars": [
"myGroup/test.jar", "myGroup/test1.jar"
],
"dependency_files": [ "myGroup/test.csv", "myGroup/test1.csv"
] }
● 响应样例
{ "is_success": true,
"message": "新建flink作业成功", "job": {
"job_id": 138,
"status_name": "job_init", "status_desc": ""
}}
状态码
状态码如表9-21所示。
表9-21 状态码
状态码 描述
200 新建Flink自定义作业成功。
API 参考 9 Flink 作业相关 API
状态码 描述
400 输入参数无效。
错误码
调用接口出错后，将不会返回上述结果，而是返回错误码和错误信息，更多介绍请参 见错误码。