更新时间:2022-12-07 GMT+08:00
新建模板
功能介绍
该API在DLI服务中新建一个用户模板,最多100个。
URI
- URI格式
- 参数说明
表1 URI参数说明 参数名称
是否必选
参数类型
说明
project_id
是
String
项目编号,用于资源隔离。获取方式请参考获取项目ID。
请求消息
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
name |
是 |
String |
模板名称。长度限制:1-64个字符 。 |
desc |
否 |
String |
模板描述。长度限制:0-512个字符。 |
sql_body |
否 |
String |
Stream SQL语句,至少包含source,query,sink三个部分。长度限制:0-2048个字符。 |
tags |
否 |
Array of Objects |
Flink作业模板的标签。具体请参考表3。 |
job_type |
否 |
String |
Flink作业模板类型。默认值为"flink_sql_job",若填写则只能为"flink_sql_job"或者"flink_opensource_sql_job"。 |
响应消息
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
is_success |
否 |
Boolean |
请求是否成功。 |
message |
否 |
String |
消息内容。 |
template |
否 |
Object |
作业更新信息。请参见表5 |
请求示例
{ "name": "simple_stream_sql", "desc": "快速上手示例", "sql_body": "select * from source_table" }
响应示例
{ "is_success": true, "message": "新建成功", "template": { "template_id": 0, "name": "IoT_example", "desc": "快速上手示例", "create_time": 1516952710040, "job_type": "flink_sql_job" } }
错误码
调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码。
父主题: Flink作业模板相关API