更新时间:2025-12-30 GMT+08:00
检查SQL语法
功能介绍
该API用于检查SQL语法。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限及授权项说明。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
Action
访问级别
Access Level
资源类型(*为必须)
Resource Type (*: required)
条件键
Condition Key
别名
Alias
依赖的授权项
Dependencies
dli::checkSql
write
-
-
-
-
URI
- URI格式:
- 参数说明
表1 URI 参数 参数名称
是否必选
参数类型
说明
project_id
是
String
项目编号,用于资源隔离。获取方式请参考获取项目ID。
请求消息
| 参数名称 | 是否必选 | 参数类型 | 说明 |
|---|---|---|---|
| sql | 是 | String | 待执行的SQL语句。 |
| currentdb | 否 | String | SQL语句执行所在的数据库。 说明:
|
响应消息
| 参数名称 | 是否必选 | 参数类型 | 说明 |
|---|---|---|---|
| is_success | 否 | Boolean | 执行请求是否成功。“true”表示请求执行成功。 |
| message | 否 | String | 系统提示信息,执行成功时,信息可能为空。 |
| job_type | 否 | String | 作业类型。包含DDL、DCL、IMPORT、EXPORT、QUERY、INSERT。
|
请求示例
检查SQL语句“select * from t1”的语法。
{
"currentdb": "db1",
"sql": "select * from t1"
} 响应示例
{
"is_success": true,
"message": "the sql is ok",
"job_type":"QUERY"
} 错误码
调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码。
父主题: SQL作业相关API