更新时间:2025-08-30 GMT+08:00
分享

创建SQL校验

功能介绍

创建SQL校验

调用方法

请参见如何调用API

URI

POST /v2/{project_id}/workspaces/{workspace_id}/siem/sql/validation

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID

约束限制:

不涉及

取值范围:

不涉及w

默认取值:

不涉及

workspace_id

String

工作空间ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

script

String

Job Script 作业脚本

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

sources

Array of TableItem objects

Source tables

modes

Array of strings

Modes

表5 TableItem

参数

参数类型

描述

project_id

String

项目ID

workspace_id

String

工作空间ID

table_id

String

UUID

table_name

String

Table name 表名

table_alias

String

Table alias

directory

String

directory 目录分组

description

String

Table description

category

String

参数解释:

表类别

  • STREAMING 流式传输

  • INDEX 索引

  • APPLICATION 应用

  • TENANT_OBS 租户对象存储

  • LAKE 数据湖

约束限制

不涉及

取值范围:

  • STREAMING

  • INDEX

  • APPLICATION

  • TENANT_OBS

  • LAKE

默认值

不涉及

lock_status

String

参数解释:

表锁状态

  • LOCKED 已锁

  • UNLOCKED 未锁

约束限制

不涉及

取值范围:

  • LOCKED

  • UNLOCKED

默认值

不涉及

process_status

String

参数解释:

表处理状态

  • COMPLETED 处理完成

  • CREATING 创建中

  • UPDATING 更新中

  • DELETING 删除中

  • TRUNCATING 清空中

  • CREATE_FAILED 创建失败

  • UPDATING_FAILED 更新失败

  • DELETING_FAILED 删除失败

  • TRUNCATE_FAILED 清空失败

约束限制

不涉及

取值范围:

  • COMPLETED

  • CREATING

  • UPDATING

  • DELETING

  • TRUNCATING

  • CREATE_FAILED

  • UPDATING_FAILED

  • DELETING_FAILED

  • TRUNCATE_FAILED

默认值

不涉及

process_error

String

参数解释:

表处理错误

  • NONE 无

约束限制

不涉及

取值范围:

  • NONE

默认值

不涉及

edit_type

String

参数解释:

表编辑类型

  • MODIFIABLE 可任意修改态

  • APPENDED 追加态 (原来的内容锁定,只可追加)

  • LOCKED 锁定态 (完全锁定,不可修改)

约束限制

不涉及

取值范围:

  • MODIFIABLE

  • APPENDED

  • LOCKED

默认值

不涉及

format

String

参数解释:

表格式

  • JSON Json格式

  • DEBEZIUM_JSON Debezium JSON 格式

  • CSV CSV格式

  • PARQUET PARQUET格式

  • ORC ORC格式

约束限制

不涉及

取值范围:

  • JSON

  • DEBEZIUM_JSON

  • CSV

  • PARQUET

  • ORC

默认值

不涉及

rw_type

String

参数解释:

表读写类型

  • READ_ONLY 只读

  • READ_WRITE 读写

  • WRITE_ONLY 只写

约束限制

不涉及

取值范围:

  • READ_ONLY

  • READ_WRITE

  • WRITE_ONLY

默认值

不涉及

owner_type

String

参数解释:

拥有者类型

  • SYSTEM 系统

  • USER 用户

  • SYSTEM_ALLOWED_DELETE 系统可删除

  • USER_ALLOWED_DELETE 用户可删除

约束限制

不涉及

取值范围:

  • SYSTEM

  • USER

  • SYSTEM_ALLOWED_DELETE

  • USER_ALLOWED_DELETE

默认值

不涉及

data_layering

String

参数解释:

数据分层

  • ODS 操作数据存储层

  • DWS 数据汇总层

  • ADS 应用数据服务层

约束限制

不涉及

取值范围:

  • ODS

  • DWS

  • ADS

默认值

不涉及

data_classification

String

参数解释:

数据分类

  • FACTUAL_DATA 事实数据

  • DIMENSION_DATA 维度数据

约束限制

不涉及

取值范围:

  • FACTUAL_DATA

  • DIMENSION_DATA

默认值

不涉及

create_time

Integer

毫秒时间戳

update_time

Integer

毫秒时间戳

delete_time

Integer

毫秒时间戳

store_size_in_bytes

Long

已使用存储容量

请求示例

响应示例

状态码

状态码

描述

200

Success

错误码

请参见错误码

相关文档