更新时间:2023-12-07 GMT+08:00

更新SQL模板

功能介绍

该接口用于更新SQL模板。

URI

  • URI格式:

    PUT /v1.0/{project_id}/sqls/{sql_id}

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

    参数

    是否必选

    参数类型

    描述

    project_id

    String

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

    sql_id

    String

    SQL模板ID。

请求参数

表2 请求参数说明

名称

是否必选

参数类型

说明

sql

String

更新后SQL模板文本。

sql_name

String

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

description

String

SQL模板的描述信息,可以为空。

group

String

SQL模板分组信息。

响应参数

表3 响应参数说明

名称

参数类型

说明

is_success

Boolean

是否成功。

message

String

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

请求示例

更新SQL模板的信息,包括模板的SQL语句、模板名称、模板的描述信息和分组信息。

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

响应示例

{
  "is_success": true,
"message": ""
}

状态码

状态码

描述

200

OK

错误码

请参见错误码