# 更新管道 - UpdatePipe #### 功能介绍 更新管道 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-secmaster/secmaster_03_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-secmaster/secmaster_03_0023.html)。 #### URI PUT /v2/{project_id}/workspaces/{workspace_id}/siem/pipes/{pipe_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。[获取项目ID](https://support.huaweicloud.com/api-secmaster/secmaster_03_0014.html) **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | workspace_id | 是 | String | **参数解释**： 工作空间ID **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | pipe_id | 是 | String | 管道ID | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。[获取用户Token](https://support.huaweicloud.com/api-secmaster/secmaster_03_0010.html) **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | pipe_alias | 否 | String | 管道别名 | | description | 否 | String | 管道描述 | | directory | 否 | String | directory 目录分组 | | category | 否 | String | **参数解释**： 管道目录 - STREAMING_TO_INDEX 流式写入索引 - STREAMING_TO_LAKE 流式写入数据湖 - STREAMING_TO_INDEX_LAKE 流式写入索引和数据湖 - STREAMING 流式传输中 **约束限制**： 不涉及 **取值范围**： - STREAMING_TO_INDEX - STREAMING_TO_LAKE - STREAMING_TO_INDEX_LAKE - STREAMING **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | project_id | String | 项目ID | | workspace_id | String | UUID | | pipe_id | String | UUID | | pipe_name | String | 管道名称 | | pipe_alias | String | 管道别名 | | category | String | **参数解释**： 管道目录 - STREAMING_TO_INDEX 流式写入索引 - STREAMING_TO_LAKE 流式写入数据湖 - STREAMING_TO_INDEX_LAKE 流式写入索引和数据湖 - STREAMING 流式传输中 **约束限制**： 不涉及 **取值范围**： - STREAMING_TO_INDEX - STREAMING_TO_LAKE - STREAMING_TO_INDEX_LAKE - STREAMING **默认取值**： 不涉及 | | directory | String | directory 目录分组 | | description | String | 管道描述 | | process_status | String | **参数解释**： 作业处理状态 - COMPLETED 已完成 - CREATING 创建中 - UPDATING 更新中 - DELETING 删除中 - UPDATING_FAILED 更新失败 - DELETING_FAILED 删除失败 **约束限制**： 不涉及 **取值范围**： - COMPLETED - CREATING - UPDATING - DELETING - UPDATING_FAILED - DELETING_FAILED **默认取值**： 不涉及 | | process_error | String | **参数解释**： 管道处理错误 - NONE 无 **约束限制**： 不涉及 **取值范围**： - NONE **默认取值**： 不涉及 | | owner_type | String | **参数解释**： 管道所有者类型 - SYSTEM 系统 - USER 用户 - CLOUD_LOG 云日志 **约束限制**： 不涉及 **取值范围**： - SYSTEM - USER - CLOUD_LOG **默认取值**： 不涉及 | | resources | Array of [PipeResource] objects | 管道资源 | | schema | [PipeSchema] object | 管道模式 | | create_time | Integer | 毫秒时间戳 | | update_time | Integer | 毫秒时间戳 | | delete_time | Integer | 毫秒时间戳 | 表5PipeResource | 参数 | 参数类型 | 描述 | |:---|:---|:---| | pipe_resource_type | Object | 管道资源 | 表6PipeSchema | 参数 | 参数类型 | 描述 | |:---|:---|:---| | columns | Array of [TableColumnForIsapPipe] objects | 管道列 | | watermark_column | String | 管道水线列 | | watermark_interval | Float | 管道水线间隔时长 | | time_filter | String | 管道过滤列 | 表7TableColumnForIsapPipe | 参数 | 参数类型 | 描述 | |:---|:---|:---| | column_name | String | 表列名称 | | 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 | 列数据类型设置 | | column_type | String | **参数解释**： 列字段类型 - PHYSICAL 物理字段 - METADATA 元数据字段 - VIRTUAL_METADATA 虚拟元数据字段 - COMPUTED 计算字段 **约束限制**： 不涉及 **取值范围**： - PHYSICAL - METADATA - VIRTUAL_METADATA - COMPUTED **默认取值**： 不涉及 | | column_type_setting | String | 列类型设置 | | default_value | String | 列默认值 | | nullable | Boolean | 列是否可为空 | | array | Boolean | 是否为数组 | | depth | Long | 列深度 | | parent_name | String | 列名称 | | own_name | String | 列名称 | #### 请求示例 更新管道描述信息 ``` https://{endpoint}//v2/{project_id}/workspaces/{workspace_id}/siem/pipes/{pipe_id} { "description" : "test_description" } ``` #### 响应示例 **状态码：200** 成功 ``` { "category" : "STREAMING_TO_INDEX", "create_time" : 1754998254580, "delete_time" : 0, "description" : "test", "directory" : "", "owner_type" : "USER", "pipe_alias" : "test", "pipe_id" : "7bdb801d-a761-451e-97bb-5c1d172ee442", "pipe_name" : "cp1_0812", "process_error" : "NONE", "process_status" : "COMPLETED", "project_id" : "c796dfc5f1644915ae072b7642a2cd93", "resources" : [ ], "schema" : { "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 }, "update_time" : 1768383374003, "workspace_id" : "5317af6c-aea0-4bd2-bd6b-08de5fd3b155" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 更新管道描述信息 ``` 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.*; public class UpdatePipeSolution { 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("")) .build(); UpdatePipeRequest request = new UpdatePipeRequest(); request.withWorkspaceId("{workspace_id}"); request.withPipeId("{pipe_id}"); UpdatePipeRequestBody body = new UpdatePipeRequestBody(); body.withDescription("test_description"); request.withBody(body); try { UpdatePipeResponse response = client.updatePipe(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()); } } } ``` - [Python] 更新管道描述信息 ``` # 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("")) \ .build() try: request = UpdatePipeRequest() request.workspace_id = "{workspace_id}" request.pipe_id = "{pipe_id}" request.body = UpdatePipeRequestBody( description="test_description" ) response = client.update_pipe(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 更新管道描述信息 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := secmaster.NewSecMasterClient(hcClient) request := &model.UpdatePipeRequest{} request.WorkspaceId = "{workspace_id}" request.PipeId = "{pipe_id}" descriptionUpdatePipeRequestBody:= "test_description" request.Body = &model.UpdatePipeRequestBody{ Description: &descriptionUpdatePipeRequestBody, } response, err := client.UpdatePipe(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SecMaster/sdk?api=UpdatePipe&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。