文档首页/ 数据湖探索 DLI/ API参考/ SQL模板相关API/ 保存SQL模板 - CreateSqlJobTemplate
更新时间:2025-10-28 GMT+08:00
分享

保存SQL模板 - CreateSqlJobTemplate

功能介绍

该接口用于存储指定的SQL语句,后续可以重复使用。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限及授权项说明
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    Action

    访问级别

    Access Level

    资源类型(*为必须)

    Resource Type (*: required)

    条件键

    Condition Key

    别名

    Alias

    依赖的授权项

    Dependencies

    dli:template:create

    write

    template *

    -

    -

    -

URI

  • URI格式:

    POST /v1.0/{project_id}/sqls

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

    参数

    是否必选

    参数类型

    描述

    project_id

    String

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

请求参数

表2 请求参数

名称

是否必选

参数类型

说明

sql

String

新增的SQL模板。

sql_name

String

新增SQL模板名称,该名称在当前工程下必须唯一。

description

String

新增SQL模板的描述信息,可以为空字符串。

group

String

SQL模板分组名称。

响应参数

表3 响应参数

名称

参数类型

说明

is_success

Boolean

是否成功。

message

String

系统提示信息,执行成功时,信息可能为空。执行失败时,用于显示执行失败的原因。

sql_id

String

新增SQL模板的ID。

group

String

SQL模板分组名称。

请求示例

创建一个SQL模板。

{
    "sql": "select * from t1",
    "sql_name": "sql1",
    "description": "use to select t1",
    "group": ""
}

响应示例

{
  "is_success": true,
  "message": "",
  "sql_id": "1994b029-3f76-4281-9e35-e370cb4ee26d1501998934432"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档