Updated on 2026-02-05 GMT+08:00

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

Pipeline watermark column.

watermark_interval

No

Float

Pipeline watermark interval.

time_filter

Yes

String

Pipeline filtering 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

Column data type settings.

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

Default value of a column.

nullable

No

Boolean

Whether a column can be empty.

array

No

Boolean

Array or not.

depth

No

Long

Column depth.

parent_name

No

String

Column name.

own_name

No

String

Column name.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

columns

Array of TableColumnForIsapPipe objects

Pipeline column.

watermark_column

String

Pipeline watermark column.

watermark_interval

Float

Pipeline watermark interval.

time_filter

String

Pipeline filtering 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

Column data type settings.

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

Default value of a column.

nullable

Boolean

Whether a column can be empty.

array

Boolean

Array or not.

depth

Long

Column depth.

parent_name

String

Column name.

own_name

String

Column name.

Example Requests

Update the pipeline schema and add a field.

https://{endpoint}/v2/{project_id}/workspaces/{workspace_id}/siem/pipes/{pipe_id}/schema

{
  "columns" : [ {
    "column_name" : "ctime",
    "column_data_type" : "TIMESTAMP",
    "column_data_type_setting" : "3",
    "column_type" : "PHYSICAL",
    "column_type_setting" : "",
    "nullable" : true,
    "array" : false,
    "depth" : 0,
    "parent_name" : "",
    "own_name" : "ctime"
  }, {
    "column_name" : "age",
    "column_data_type" : "INT",
    "column_data_type_setting" : "",
    "column_type" : "PHYSICAL",
    "column_type_setting" : "",
    "nullable" : true,
    "array" : false,
    "depth" : 0,
    "parent_name" : "",
    "own_name" : "age"
  }, {
    "column_name" : "test_add",
    "column_data_type" : "BIGINT",
    "column_data_type_setting" : "",
    "column_type" : "PHYSICAL",
    "column_type_setting" : "",
    "nullable" : true,
    "array" : false,
    "depth" : 0,
    "own_name" : "test_add"
  } ],
  "watermark_column" : "ctime",
  "watermark_interval" : 5,
  "time_filter" : "ctime"
}

Example Responses

Status code: 200

Request succeeded.

{
  "columns" : [ {
    "array" : false,
    "column_data_type" : "TIMESTAMP",
    "column_data_type_setting" : "3",
    "column_name" : "ctime",
    "column_type" : "PHYSICAL",
    "column_type_setting" : "",
    "depth" : 0,
    "nullable" : true,
    "own_name" : "ctime",
    "parent_name" : ""
  }, {
    "array" : false,
    "column_data_type" : "INT",
    "column_data_type_setting" : "",
    "column_name" : "age",
    "column_type" : "PHYSICAL",
    "column_type_setting" : "",
    "depth" : 0,
    "nullable" : true,
    "own_name" : "age",
    "parent_name" : ""
  } ],
  "time_filter" : "ctime",
  "watermark_column" : "ctime",
  "watermark_interval" : 5
}

SDK Sample Code

The SDK sample code is as follows.

Update the pipeline schema and add a field.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.secmaster.v2.region.SecMasterRegion;
import com.huaweicloud.sdk.secmaster.v2.*;
import com.huaweicloud.sdk.secmaster.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class UpdatePipeSchemaSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        SecMasterClient client = SecMasterClient.newBuilder()
                .withCredential(auth)
                .withRegion(SecMasterRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdatePipeSchemaRequest request = new UpdatePipeSchemaRequest();
        request.withWorkspaceId("{workspace_id}");
        request.withPipeId("{pipe_id}");
        PipeSchema body = new PipeSchema();
        List<TableColumnForIsapPipe> listbodyColumns = new ArrayList<>();
        listbodyColumns.add(
            new TableColumnForIsapPipe()
                .withColumnName("ctime")
                .withColumnDataType(TableColumnForIsapPipe.ColumnDataTypeEnum.fromValue("TIMESTAMP"))
                .withColumnDataTypeSetting("3")
                .withColumnType(TableColumnForIsapPipe.ColumnTypeEnum.fromValue("PHYSICAL"))
                .withColumnTypeSetting("")
                .withNullable(true)
                .withArray(false)
                .withDepth(0L)
                .withParentName("")
                .withOwnName("ctime")
        );
        listbodyColumns.add(
            new TableColumnForIsapPipe()
                .withColumnName("age")
                .withColumnDataType(TableColumnForIsapPipe.ColumnDataTypeEnum.fromValue("INT"))
                .withColumnDataTypeSetting("")
                .withColumnType(TableColumnForIsapPipe.ColumnTypeEnum.fromValue("PHYSICAL"))
                .withColumnTypeSetting("")
                .withNullable(true)
                .withArray(false)
                .withDepth(0L)
                .withParentName("")
                .withOwnName("age")
        );
        listbodyColumns.add(
            new TableColumnForIsapPipe()
                .withColumnName("test_add")
                .withColumnDataType(TableColumnForIsapPipe.ColumnDataTypeEnum.fromValue("BIGINT"))
                .withColumnDataTypeSetting("")
                .withColumnType(TableColumnForIsapPipe.ColumnTypeEnum.fromValue("PHYSICAL"))
                .withColumnTypeSetting("")
                .withNullable(true)
                .withArray(false)
                .withDepth(0L)
                .withOwnName("test_add")
        );
        body.withTimeFilter("ctime");
        body.withWatermarkInterval(5f);
        body.withWatermarkColumn("ctime");
        body.withColumns(listbodyColumns);
        request.withBody(body);
        try {
            UpdatePipeSchemaResponse response = client.updatePipeSchema(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Update the pipeline schema and add a field.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksecmaster.v2.region.secmaster_region import SecMasterRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksecmaster.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = SecMasterClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdatePipeSchemaRequest()
        request.workspace_id = "{workspace_id}"
        request.pipe_id = "{pipe_id}"
        listColumnsbody = [
            TableColumnForIsapPipe(
                column_name="ctime",
                column_data_type="TIMESTAMP",
                column_data_type_setting="3",
                column_type="PHYSICAL",
                column_type_setting="",
                nullable=True,
                array=False,
                depth=0,
                parent_name="",
                own_name="ctime"
            ),
            TableColumnForIsapPipe(
                column_name="age",
                column_data_type="INT",
                column_data_type_setting="",
                column_type="PHYSICAL",
                column_type_setting="",
                nullable=True,
                array=False,
                depth=0,
                parent_name="",
                own_name="age"
            ),
            TableColumnForIsapPipe(
                column_name="test_add",
                column_data_type="BIGINT",
                column_data_type_setting="",
                column_type="PHYSICAL",
                column_type_setting="",
                nullable=True,
                array=False,
                depth=0,
                own_name="test_add"
            )
        ]
        request.body = PipeSchema(
            time_filter="ctime",
            watermark_interval=5,
            watermark_column="ctime",
            columns=listColumnsbody
        )
        response = client.update_pipe_schema(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Update the pipeline schema and add a field.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := secmaster.NewSecMasterClient(
        secmaster.SecMasterClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdatePipeSchemaRequest{}
	request.WorkspaceId = "{workspace_id}"
	request.PipeId = "{pipe_id}"
	columnDataTypeSettingColumns:= "3"
	columnTypeColumns:= model.GetTableColumnForIsapPipeColumnTypeEnum().PHYSICAL
	columnTypeSettingColumns:= ""
	nullableColumns:= true
	arrayColumns:= false
	depthColumns:= int64(0)
	parentNameColumns:= ""
	ownNameColumns:= "ctime"
	columnDataTypeSettingColumns1:= ""
	columnTypeColumns1:= model.GetTableColumnForIsapPipeColumnTypeEnum().PHYSICAL
	columnTypeSettingColumns1:= ""
	nullableColumns1:= true
	arrayColumns1:= false
	depthColumns1:= int64(0)
	parentNameColumns1:= ""
	ownNameColumns1:= "age"
	columnDataTypeSettingColumns2:= ""
	columnTypeColumns2:= model.GetTableColumnForIsapPipeColumnTypeEnum().PHYSICAL
	columnTypeSettingColumns2:= ""
	nullableColumns2:= true
	arrayColumns2:= false
	depthColumns2:= int64(0)
	ownNameColumns2:= "test_add"
	var listColumnsbody = []model.TableColumnForIsapPipe{
        {
            ColumnName: "ctime",
            ColumnDataType: model.GetTableColumnForIsapPipeColumnDataTypeEnum().TIMESTAMP,
            ColumnDataTypeSetting: &columnDataTypeSettingColumns,
            ColumnType: &columnTypeColumns,
            ColumnTypeSetting: &columnTypeSettingColumns,
            Nullable: &nullableColumns,
            Array: &arrayColumns,
            Depth: &depthColumns,
            ParentName: &parentNameColumns,
            OwnName: &ownNameColumns,
        },
        {
            ColumnName: "age",
            ColumnDataType: model.GetTableColumnForIsapPipeColumnDataTypeEnum().INT,
            ColumnDataTypeSetting: &columnDataTypeSettingColumns1,
            ColumnType: &columnTypeColumns1,
            ColumnTypeSetting: &columnTypeSettingColumns1,
            Nullable: &nullableColumns1,
            Array: &arrayColumns1,
            Depth: &depthColumns1,
            ParentName: &parentNameColumns1,
            OwnName: &ownNameColumns1,
        },
        {
            ColumnName: "test_add",
            ColumnDataType: model.GetTableColumnForIsapPipeColumnDataTypeEnum().BIGINT,
            ColumnDataTypeSetting: &columnDataTypeSettingColumns2,
            ColumnType: &columnTypeColumns2,
            ColumnTypeSetting: &columnTypeSettingColumns2,
            Nullable: &nullableColumns2,
            Array: &arrayColumns2,
            Depth: &depthColumns2,
            OwnName: &ownNameColumns2,
        },
    }
	watermarkIntervalPipeSchema:= float32(5)
	watermarkColumnPipeSchema:= "ctime"
	request.Body = &model.PipeSchema{
		TimeFilter: "ctime",
		WatermarkInterval: &watermarkIntervalPipeSchema,
		WatermarkColumn: &watermarkColumnPipeSchema,
		Columns: listColumnsbody,
	}
	response, err := client.UpdatePipeSchema(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.