Help Center/ SecMaster/ API Reference/ Security Analysis V2 APIs/ Pipeline Management/ Updating the Pipeline Structure

Updated on 2025-10-29 GMT+08:00

Online Debugging

CLI Examples

View PDF

Updating the Pipeline Structure

Function

This API is used to update the pipeline structure.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID Constraints N/A Range N/A Default Value N/A
workspace_id	Yes	String	Workspace ID.
pipe_id	Yes	String	Pipeline ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
columns	Yes	Array of TableColumnForIsapPipe objects	Pipeline column.
watermark_column	No	String	Pipe watermark column
watermark_interval	No	Float	Pipe watermark delay interval
time_filter	Yes	String	Pipe time filter column

**Table 4** TableColumnForIsapPipe
Parameter	Mandatory	Type	Description
column_name	Yes	String	Table column name
column_data_type	Yes	String	Definition Column data type. ROW: row type MAP_STRING: string mapping type MAP_DECIMAL: decimal mapping type TINYINT: tiny integer SMALLINT: small integer INT: integer BIGINT: long integer DECIMAL: decimal data type FLOAT: single-precision floating point DOUBLE: double-precision floating point CHAR: fixed-length string VARCHAR: variable-length string STRING: string type KEYWORD: keyword type BOOLEAN: boolean type DATE: date type TIME: time type TIMESTAMP: timestamp type TIMESTAMP_LTZ: local timestamp type Constraints N/A Range ROW MAP_STRING MAP_DECIMAL TINYINT SMALLINT INT BIGINT DECIMAL FLOAT DOUBLE CHAR VARCHAR STRING KEYWORD BOOLEAN DATE TIME TIMESTAMP TIMESTAMP_LTZ Default Value N/A
column_data_type_setting	No	String	Table column data type setting
column_type	No	String	Definition Column field type. PHYSICAL: physical field METADATA: metadata field VIRTUAL_METADATA: virtual metadata field COMPUTED: computation field Constraints N/A Range PHYSICAL METADATA VIRTUAL_METADATA COMPUTED Default Value N/A
column_type_setting	No	String	Column type settings.
default_value	No	String	Table column default value
nullable	No	Boolean	Table column nullable
array	No	Boolean	Is an array
depth	No	Long	Table column depth
parent_name	No	String	Table column name
own_name	No	String	Table column name without parent name

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
columns	Array of TableColumnForIsapPipe objects	Pipeline column.
watermark_column	String	Pipe watermark column
watermark_interval	Float	Pipe watermark delay interval
time_filter	String	Pipe time filter column

**Table 6** TableColumnForIsapPipe
Parameter	Type	Description
column_name	String	Table column name
column_data_type	String	Definition Column data type. ROW: row type MAP_STRING: string mapping type MAP_DECIMAL: decimal mapping type TINYINT: tiny integer SMALLINT: small integer INT: integer BIGINT: long integer DECIMAL: decimal data type FLOAT: single-precision floating point DOUBLE: double-precision floating point CHAR: fixed-length string VARCHAR: variable-length string STRING: string type KEYWORD: keyword type BOOLEAN: boolean type DATE: date type TIME: time type TIMESTAMP: timestamp type TIMESTAMP_LTZ: local timestamp type Constraints N/A Range ROW MAP_STRING MAP_DECIMAL TINYINT SMALLINT INT BIGINT DECIMAL FLOAT DOUBLE CHAR VARCHAR STRING KEYWORD BOOLEAN DATE TIME TIMESTAMP TIMESTAMP_LTZ Default Value N/A
column_data_type_setting	String	Table column data type setting
column_type	String	Definition Column field type. PHYSICAL: physical field METADATA: metadata field VIRTUAL_METADATA: virtual metadata field COMPUTED: computation field Constraints N/A Range PHYSICAL METADATA VIRTUAL_METADATA COMPUTED Default Value N/A
column_type_setting	String	Column type settings.
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

Example Requests

None

Example Responses

None

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent topic: Pipeline Management

Previous topic: Pipeline Management

Next topic: Querying Pipeline Details

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.