文档

ValidateSqlStatement - 验证sql语句

更新时间:

校验sql作业代码。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

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": "",
    "errorDetails": {
      "lineNumber": "",
      "columnNumber": "",
      "endLineNumber": "",
      "endColumnNumber": "",
      "message": "",
      "invalidflinkConf": [
        ""
      ]
    }
  }
}

错误码

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

变更历史

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