文档首页/ 安全云脑 SecMaster/ API参考/ API V3/ 管道管理/ 更新管道结构
更新时间：2025-08-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更新管道结构

功能介绍

更新管道结构

调用方法

请参见如何调用API。

URI

PUT /v2/{project_id}/workspaces/{workspace_id}/siem/pipes/{pipe_id}/schema

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及w

默认取值：

不涉及

workspace_id

是

String

工作空间ID

pipe_id

是

String

管道Id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

columns

是

Array of TableColumnForIsapPipe objects

管道列

watermark_column

否

String

Pipe watermark column

watermark_interval

否

Float

Pipe watermark delay interval

time_filter

是

String

Pipe time filter column
表4 TableColumnForIsapPipe

参数

是否必选

参数类型

描述

column_name

是

String

Table column name

column_data_type

是

String

参数解释:

列字段数据类型

  • ROW 行类型

  • MAP_STRING 字符串映射类型

  • MAP_DECIMAL 小数映射类型

  • TINYINT 微整型

  • SMALLINT 小整型

  • INT 整型

  • BIGINT 长整型

  • DECIMAL 精确小数类型

  • FLOAT 单精度浮点数

  • DOUBLE 双精度浮点数

  • CHAR 定长字符串

  • VARCHAR 不定长字符串

  • STRING 字符串类型

  • KEYWORD 关键字类型

  • BOOLEAN 布尔类型

  • DATE 日期类型

  • TIME 事件类型

  • TIMESTAMP 时间戳类型

  • TIMESTAMP_LTZ 本地时间戳类型

约束限制

不涉及

取值范围:

  • ROW

  • MAP_STRING

  • MAP_DECIMAL

  • TINYINT

  • SMALLINT

  • INT

  • BIGINT

  • DECIMAL

  • FLOAT

  • DOUBLE

  • CHAR

  • VARCHAR

  • STRING

  • KEYWORD

  • BOOLEAN

  • DATE

  • TIME

  • TIMESTAMP

  • TIMESTAMP_LTZ

默认值

不涉及

column_data_type_setting

否

String

Table column data type setting

column_type

否

String

参数解释:

列字段类型

  • PHYSICAL 物理字段

  • METADATA 元数据字段

  • VIRTUAL_METADATA 虚拟元数据字段

  • COMPUTED 计算字段

约束限制

不涉及

取值范围:

  • PHYSICAL

  • METADATA

  • VIRTUAL_METADATA

  • COMPUTED

默认值

不涉及

column_type_setting

否

String

列类型设置

default_value

否

String

Table column default value

nullable

否

Boolean

Table column nullable

array

否

Boolean

Is an array

depth

否

Long

Table column depth

parent_name

否

String

Table column name

own_name

否

String

Table column name without parent name

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

columns

Array of TableColumnForIsapPipe objects

管道列

watermark_column

String

Pipe watermark column

watermark_interval

Float

Pipe watermark delay interval

time_filter

String

Pipe time filter column
表6 TableColumnForIsapPipe

参数

参数类型

描述

column_name

String

Table column name

column_data_type

String

参数解释:

列字段数据类型

  • ROW 行类型

  • MAP_STRING 字符串映射类型

  • MAP_DECIMAL 小数映射类型

  • TINYINT 微整型

  • SMALLINT 小整型

  • INT 整型

  • BIGINT 长整型

  • DECIMAL 精确小数类型

  • FLOAT 单精度浮点数

  • DOUBLE 双精度浮点数

  • CHAR 定长字符串

  • VARCHAR 不定长字符串

  • STRING 字符串类型

  • KEYWORD 关键字类型

  • BOOLEAN 布尔类型

  • DATE 日期类型

  • TIME 事件类型

  • TIMESTAMP 时间戳类型

  • TIMESTAMP_LTZ 本地时间戳类型

约束限制

不涉及

取值范围:

  • ROW

  • MAP_STRING

  • MAP_DECIMAL

  • TINYINT

  • SMALLINT

  • INT

  • BIGINT

  • DECIMAL

  • FLOAT

  • DOUBLE

  • CHAR

  • VARCHAR

  • STRING

  • KEYWORD

  • BOOLEAN

  • DATE

  • TIME

  • TIMESTAMP

  • TIMESTAMP_LTZ

默认值

不涉及

column_data_type_setting

String

Table column data type setting

column_type

String

参数解释:

列字段类型

  • PHYSICAL 物理字段

  • METADATA 元数据字段

  • VIRTUAL_METADATA 虚拟元数据字段

  • COMPUTED 计算字段

约束限制

不涉及

取值范围:

  • PHYSICAL

  • METADATA

  • VIRTUAL_METADATA

  • COMPUTED

默认值

不涉及

column_type_setting

String

列类型设置

default_value

String

Table column default value

nullable

Boolean

Table column nullable

array

Boolean

Is an array

depth

Long

Table column depth

parent_name

String

Table column name

own_name

String

Table column name without parent name

请求示例

无

响应示例

无

状态码

状态码

描述

200

成功

错误码

请参见错误码。

父主题： 管道管理

相关文档