文档

ValidateSqlStatement - 验证sql语句

更新时间:

校验sql作业代码。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
stream:ValidateSqlStatementnone
  • 全部资源
    *

请求语法

POST /api/v2/namespaces/{namespace}/sql-statement/validate

请求参数

名称类型必填描述示例值
workspacestring

工作空间 ID。

a14bd5d90a****
namespacestring

项目空间名称。

default-namespace
bodySqlStatementWithContext

待验证的 sql 内容。

返回参数

名称类型描述示例值
object

响应数据。

requestIdstring

请求 ID。

CBC799F0-****-1D30-8A4F-882ED4DD5E02
successboolean

表示业务请求是否成功。

true
httpCodeinteger

业务状态码,统一为 200。

200
errorCodestring

当 success 为 false 时,该值不为空,表示业务错误码;当 success 为 true 时,该值为空。

""
errorMessagestring

当 success 为 false 时,该值不为空,表示业务错误信息;当 success 为 true 时,该值为空。

""
dataSqlStatementValidationResult

本数据结构代表 sql 验证结果详情。

示例

正常返回示例

JSON格式

{
  "requestId": "CBC799F0-****-1D30-8A4F-882ED4DD5E02",
  "success": true,
  "httpCode": 200,
  "errorCode": "\"\"",
  "errorMessage": "\"\"",
  "data": {
    "success": true,
    "message": "“”",
    "validationResult": "VALIDATION_RESULT_INVALID",
    "errorDetails": {
      "lineNumber": "3",
      "columnNumber": "2",
      "endLineNumber": "5",
      "endColumnNumber": "11",
      "message": "\"\"",
      "invalidflinkConf": [
        "{\"k:v\"}"
      ]
    }
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史