更新时间:2023-06-15 GMT+08:00

更新模板

功能介绍

该API用于对DLI服务中已有的模板进行更新。

URI

  • URI格式

    PUT /v1.0/{project_id}/streaming/job-templates/{template_id}

  • 参数说明
    表1 URI参数说明

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目编号,用于资源隔离。获取方式请参考获取项目ID

    template_id

    String

    模板ID。

请求消息

表2 请求参数说明

参数名称

是否必选

参数类型

说明

name

String

模板名称。长度限制:0-57个字符。

desc

String

模板描述。长度限制:0-512个字符。

sql_body

String

Stream SQL语句,至少包含source,query,sink三个部分。长度限制:0-1024*1024个字符。

响应消息

表3 响应参数说明

参数名称

是否必选

参数类型

说明

is_success

Boolean

执行请求是否成功。“true”表示请求执行成功。

message

String

系统提示信息,执行成功时,信息可能为空。

请求示例

更新作业模板的信息,包括更新模板名称、模板描述信息、模板的SQL语句。

{
    "name": "simple_stream_sql",
    "desc": "快速上手示例",
    "sql_body": "select * from source_table"
}

响应示例

{
    "is_success": "true",
    "message": "更新模板成功"
}

状态码

状态码如表4所示。

表4 状态码

状态码

描述

200

更新模板成功。

400

输入参数无效。

错误码

调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码